Google Cloud Ces V1 Client - Class ImportAppRequest (0.1.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class ImportAppRequest.

Request message for AgentService.ImportApp.

Generated from protobuf message google.cloud.ces.v1.ImportAppRequest

Namespace

Google \ Cloud \ Ces \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ gcs_uri	string The Google Cloud Storage URI from which to import app. The format of this URI must be gs://<bucket-name>/<object-name>.
↳ app_content	string Raw bytes representing the compressed zip file with the app folder structure.
↳ parent	string Required. The parent resource name with the location of the app to import.
↳ display_name	string Optional. The display name of the app to import. * * If the app is created on import, and the display name is specified, the imported app will use this display name. If a conflict is detected with an existing app, a timestamp will be appended to the display name to make it unique. * * If the app is a reimport, this field should not be set. Providing a display name during reimport will result in an INVALID_ARGUMENT error.
↳ app_id	string Optional. The ID to use for the imported app. * * If not specified, a unique ID will be automatically assigned for the app. * * Otherwise, the imported app will use this ID as the final component of its resource name. If an app with the same ID already exists at the specified location in the project, the content of the existing app will be replaced.
↳ import_options	ImportAppRequest\ImportOptions Optional. Options governing the import process for the app.
↳ ignore_app_lock	bool Optional. Flag for overriding the app lock during import. If set to true, the import process will ignore the app lock.

getGcsUri

The Google Cloud Storage URI from which to import app. The format of this URI must be gs://<bucket-name>/<object-name>.

Returns
Type	Description
string

hasGcsUri

setGcsUri

The Google Cloud Storage URI from which to import app. The format of this URI must be gs://<bucket-name>/<object-name>.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getAppContent

Raw bytes representing the compressed zip file with the app folder structure.

Returns
Type	Description
string

hasAppContent

setAppContent

Raw bytes representing the compressed zip file with the app folder structure.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getParent

Required. The parent resource name with the location of the app to import.

Returns
Type	Description
string

setParent

Required. The parent resource name with the location of the app to import.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDisplayName

Optional. The display name of the app to import.

• If the app is created on import, and the display name is specified, the imported app will use this display name. If a conflict is detected with an existing app, a timestamp will be appended to the display name to make it unique.
• If the app is a reimport, this field should not be set. Providing a display name during reimport will result in an INVALID_ARGUMENT error.

Returns
Type	Description
string

setDisplayName

Optional. The display name of the app to import.

• If the app is created on import, and the display name is specified, the imported app will use this display name. If a conflict is detected with an existing app, a timestamp will be appended to the display name to make it unique.
• If the app is a reimport, this field should not be set. Providing a display name during reimport will result in an INVALID_ARGUMENT error.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getAppId

Optional. The ID to use for the imported app.

• If not specified, a unique ID will be automatically assigned for the app.
• Otherwise, the imported app will use this ID as the final component of its resource name. If an app with the same ID already exists at the specified location in the project, the content of the existing app will be replaced.

Returns
Type	Description
string

setAppId

Optional. The ID to use for the imported app.

• If not specified, a unique ID will be automatically assigned for the app.
• Otherwise, the imported app will use this ID as the final component of its resource name. If an app with the same ID already exists at the specified location in the project, the content of the existing app will be replaced.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getImportOptions

Optional. Options governing the import process for the app.

Returns
Type	Description
ImportAppRequest\ImportOptions|null

hasImportOptions

clearImportOptions

setImportOptions

Optional. Options governing the import process for the app.

Parameter
Name	Description
var	ImportAppRequest\ImportOptions

Returns
Type	Description
$this

getIgnoreAppLock

Optional. Flag for overriding the app lock during import.

If set to true, the import process will ignore the app lock.

Returns
Type	Description
bool

setIgnoreAppLock

Optional. Flag for overriding the app lock during import.

If set to true, the import process will ignore the app lock.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getApp

Returns
Type	Description
string

static::build

Parameters
Name	Description
parent	string Required. The parent resource name with the location of the app to import. Please see AgentServiceClient::locationName() for help formatting this field.
displayName	string Optional. The display name of the app to import. If the app is created on import, and the display name is specified, the imported app will use this display name. If a conflict is detected with an existing app, a timestamp will be appended to the display name to make it unique. If the app is a reimport, this field should not be set. Providing a display name during reimport will result in an INVALID_ARGUMENT error.
appId	string Optional. The ID to use for the imported app. If not specified, a unique ID will be automatically assigned for the app. Otherwise, the imported app will use this ID as the final component of its resource name. If an app with the same ID already exists at the specified location in the project, the content of the existing app will be replaced.

Returns
Type	Description
ImportAppRequest