VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::content::library::SubscriptionInfo::Builder Class Reference

Builder class for SubscriptionInfo. More...

List of all members.

Public Member Functions

 Builder ()
 Constructor with parameters for the required properties of SubscriptionInfo.
Builder SetAuthenticationMethod (vmware.content.library.SubscriptionInfo.AuthenticationMethod authenticationMethod)
 Indicate how the subscribed library should authenticate ( BASIC, NONE) with the published library endpoint.
Builder SetAutomaticSyncEnabled (bool?automaticSyncEnabled)
 Whether the library should participate in automatic library synchronization.
Builder SetOnDemand (bool?onDemand)
 Indicates whether a library item's content will be synchronized only on demand.
Builder SetPassword (char[] password)
 The password to use when authenticating.
Builder SetSslThumbprint (string sslThumbprint)
 An optional SHA-1 hash of the SSL certificate for the remote endpoint.
Builder SetSubscriptionUrl (global::System.Uri subscriptionUrl)
 The URL of the endpoint where the metadata for the remotely published library is being served.
Builder SetUserName (string userName)
 The username to use when authenticating.
Builder SetSourceInfo (vmware.content.library.SourceInfo sourceInfo)
 Information about the source published library.
SubscriptionInfo Build ()

Detailed Description


Constructor & Destructor Documentation

vmware::content::library::SubscriptionInfo::Builder::Builder ( ) [inline]

Constructor with parameters for the required properties of SubscriptionInfo.


Member Function Documentation

SubscriptionInfo vmware::content::library::SubscriptionInfo::Builder::Build ( ) [inline]
Builder vmware::content::library::SubscriptionInfo::Builder::SetAuthenticationMethod ( vmware.content.library.SubscriptionInfo.AuthenticationMethod  authenticationMethod) [inline]

Indicate how the subscribed library should authenticate ( BASIC, NONE) with the published library endpoint.

Builder vmware::content::library::SubscriptionInfo::Builder::SetAutomaticSyncEnabled ( bool?  automaticSyncEnabled) [inline]

Whether the library should participate in automatic library synchronization.

In order for automatic synchronization to happen, the global vmware.content.ConfigurationModel.automaticSyncEnabled option must also be true. The subscription is still active even when automatic synchronization is turned off, but synchronization is only activated with an explicit call to vmware.content.SubscribedLibrary.Sync or SubscribedItem.Sync . In other words, manual synchronization is still available even when automatic synchronization is disabled.

Builder vmware::content::library::SubscriptionInfo::Builder::SetOnDemand ( bool?  onDemand) [inline]

Indicates whether a library item's content will be synchronized only on demand.

If this is set to true , then the library item's metadata will be synchronized but the item's content (its files) will not be synchronized. The Content Library Service will synchronize the content upon request only. This can cause the first use of the content to have a noticeable delay.

Items without synchronized content can be forcefully synchronized in advance using the SubscribedItem.Sync call with {@param.name forceSyncContent} set to true. Once content has been synchronized, the content can removed with the SubscribedItem.Evict call.

If this value is set to false , all content will be synchronized in advance.

Builder vmware::content::library::SubscriptionInfo::Builder::SetPassword ( char[]  password) [inline]

The password to use when authenticating.

The password must be set when using a password-based authentication method; empty strings are not allowed.

Builder vmware::content::library::SubscriptionInfo::Builder::SetSourceInfo ( vmware.content.library.SourceInfo  sourceInfo) [inline]

Information about the source published library.

This field will be set for a subscribed library which is associated with a subscription of the published library. This attribute was added in vSphere API 6.7.2.

Builder vmware::content::library::SubscriptionInfo::Builder::SetSslThumbprint ( string  sslThumbprint) [inline]

An optional SHA-1 hash of the SSL certificate for the remote endpoint.

If this value is defined the SSL certificate will be verified by comparing it to the SSL thumbprint. The SSL certificate must verify against the thumbprint. When specified, the standard certificate chain validation behavior is not used. The certificate chain is validated normally if this value is null.

Builder vmware::content::library::SubscriptionInfo::Builder::SetSubscriptionUrl ( global::System.Uri  subscriptionUrl) [inline]

The URL of the endpoint where the metadata for the remotely published library is being served.

This URL can be the PublishInfo.publishUrl of the published library (for example, https://server/path/lib.json).

If the source content comes from a published library with PublishInfo.persistJsonEnabled , the subscription URL can be a URL pointing to the library JSON file on a datastore or remote file system. The supported formats are:

vSphere 6.5

  • ds:///vmfs/volumes/{uuid}/mylibrary/lib.json (for datastore)
  • nfs://server/path/mylibrary/lib.json (for NFSv3 server on vCenter Server Appliance)
  • nfs://server/path/mylibrary/lib.json?version=4 (for NFSv4 server on vCenter Server Appliance)
  • smb://server/path/mylibrary/lib.json (for SMB server)

vSphere 6.0

When you specify a DS subscription URL, the datastore must be on the same vCenter Server as the subscribed library. When you specify an NFS or SMB subscription URL, the StorageBacking.storageUri of the subscribed library must be on the same remote file server and should share a common parent path with the subscription URL.

Builder vmware::content::library::SubscriptionInfo::Builder::SetUserName ( string  userName) [inline]

The username to use when authenticating.

The username must be set when using a password-based authentication method. Empty strings are allowed for usernames.


The documentation for this class was generated from the following file: