Com::Vmware::Content::Library::PublishInfo Class Reference

Inheritance diagram for Com::Vmware::Content::Library::PublishInfo:

Classes
class	AuthenticationMethod

Avaliable Methods
public method	get_persist_json_enabled ()
public method	set_authentication_method ()
public method	set_user_name ()
public method	set_password ()
public method	set_publish_url ()
public method	get_publish_url ()
public method	get_user_name ()
public method	get_password ()
public method	get_authentication_method ()
public method	set_published ()
public method	set_persist_json_enabled ()
public method	new ()
public method	get_published ()

Detailed Description

The Com::Vmware::Content::Library::PublishInfo class defines how a local library is published publicly for synchronization to other libraries.

Member Function Documentation

public method Com::Vmware::Content::Library::PublishInfo::get_authentication_method

(

)

Gets the value of 'authentication_method' property.

Return values

authentication_method

- The current value of the field. Indicates how a subscribed library should authenticate (BASIC, NONE) to the published library endpoint. optional#

Code:

public method Com::Vmware::Content::Library::PublishInfo::get_password

(

)

Gets the value of 'password' property.

Return values

password

- The current value of the field. The password to require for authentication. optional#

Code:

public method Com::Vmware::Content::Library::PublishInfo::get_persist_json_enabled

(

)

Gets the value of 'persist_json_enabled' property.

Return values

persist_json_enabled

- The current value of the field. Whether library and library item metadata are persisted in the storage backing as JSON files. This flag only applies if the local library is published.

Enabling JSON persistence allows you to synchronize a subscribed library manually instead of over HTTP. You copy the local library content and metadata to another storage backing manually and then create a subscribed library referencing the location of the library JSON file in the :attr:Com::Vmware::Content::Library::SubscriptionInfo.subscription_url . When the subscribed library's storage backing matches the subscription URL, files do not need to be copied to the subscribed library.

For a library backed by a datastore, the library JSON file will be stored at the path contentlib-{library_id}/lib.json on the datastore.

For a library backed by a remote file system, the library JSON file will be stored at {library_id}/lib.json in the remote file system path.

optional#

Code:

public method Com::Vmware::Content::Library::PublishInfo::get_publish_url

(

)

Gets the value of 'publish_url' property.

Return values

publish_url

- The current value of the field. The URL to which the library metadata is published by the Content Library Service.

This value can be used to set the :attr:Com::Vmware::Content::Library::SubscriptionInfo.subscription_url property when creating a subscribed library.

optional#

Code:

public method Com::Vmware::Content::Library::PublishInfo::get_published

(

)

Gets the value of 'published' property.

Return values

published

- The current value of the field. Whether the local library is published. optional#

Code:

public method Com::Vmware::Content::Library::PublishInfo::get_user_name

(

)

Gets the value of 'user_name' property.

Return values

user_name

- The current value of the field. The username to require for authentication. optional#

Code:

public method Com::Vmware::Content::Library::PublishInfo::new

(

)

Constructor to initialize the Com::Vmware::Content::Library::PublishInfo structure

Return values

Blessed

object

Code:

public method Com::Vmware::Content::Library::PublishInfo::set_authentication_method

(

)

Sets the given value for 'authentication_method' property.

Parameters

authentication_method

- New value for the field. Indicates how a subscribed library should authenticate (BASIC, NONE) to the published library endpoint.

Code:

public method Com::Vmware::Content::Library::PublishInfo::set_password

(

)

Sets the given value for 'password' property.

Parameters

password

- New value for the field. The password to require for authentication.

Code:

public method Com::Vmware::Content::Library::PublishInfo::set_persist_json_enabled

(

)

Sets the given value for 'persist_json_enabled' property.

Parameters

persist_json_enabled

- New value for the field. Whether library and library item metadata are persisted in the storage backing as JSON files. This flag only applies if the local library is published.

Enabling JSON persistence allows you to synchronize a subscribed library manually instead of over HTTP. You copy the local library content and metadata to another storage backing manually and then create a subscribed library referencing the location of the library JSON file in the :attr:Com::Vmware::Content::Library::SubscriptionInfo.subscription_url . When the subscribed library's storage backing matches the subscription URL, files do not need to be copied to the subscribed library.

For a library backed by a datastore, the library JSON file will be stored at the path contentlib-{library_id}/lib.json on the datastore.

For a library backed by a remote file system, the library JSON file will be stored at {library_id}/lib.json in the remote file system path.

Code:

public method Com::Vmware::Content::Library::PublishInfo::set_publish_url

(

)

Sets the given value for 'publish_url' property.

Parameters

publish_url

- New value for the field. The URL to which the library metadata is published by the Content Library Service.

This value can be used to set the :attr:Com::Vmware::Content::Library::SubscriptionInfo.subscription_url property when creating a subscribed library.

Code:

public method Com::Vmware::Content::Library::PublishInfo::set_published

(

)

Sets the given value for 'published' property.

Parameters

published

- New value for the field. Whether the local library is published.

Code:

public method Com::Vmware::Content::Library::PublishInfo::set_user_name

(

)

Sets the given value for 'user_name' property.

Parameters

user_name

- New value for the field. The username to require for authentication.

Code:

---

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

• Com/Vmware/Content/Library/PublishInfo.pm