Close httplib2 connections.
create(parent, body=None, deploymentId=None, x__xgafv=None)
Creates a new deployment in the given app.
delete(name, etag=None, x__xgafv=None)
Deletes the specified deployment.
Gets details of the specified deployment.
list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists deployments in the given app.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the specified deployment.
close()
Close httplib2 connections.
create(parent, body=None, deploymentId=None, x__xgafv=None)
Creates a new deployment in the given app.
Args:
parent: string, Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}` (required)
body: object, The request body.
The object takes the form of:
{ # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.
"appVersion": "A String", # Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
"channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment.
"channelType": "A String", # Optional. The type of the channel profile.
"disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt.
"disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency).
"noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high".
"personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile.
"persona": "A String", # Optional. The persona of the channel.
},
"profileId": "A String", # Optional. The unique identifier of the channel profile.
"webWidgetConfig": { # Message for configuration for the web widget. # Optional. The configuration for the web widget.
"modality": "A String", # Optional. The modality of the web widget.
"securitySettings": { # Security settings for the web widget. # Optional. The security settings of the web widget.
"allowedOrigins": [ # Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"
"A String",
],
"enableOriginCheck": True or False, # Optional. Indicates whether origin check for the web widget is enabled. If `true`, the web widget will check the origin of the website that loads the web widget and only allow it to be loaded in the same origin or any of the allowed origins.
"enablePublicAccess": True or False, # Optional. Indicates whether public access to the web widget is enabled. If `true`, the web widget will be publicly accessible. If `false`, the web widget must be integrated with your own authentication and authorization system to return valid credentials for accessing the CES agent.
"enableRecaptcha": True or False, # Optional. Indicates whether reCAPTCHA verification for the web widget is enabled.
},
"theme": "A String", # Optional. The theme of the web widget.
"webWidgetTitle": "A String", # Optional. The title of the web widget.
},
},
"createTime": "A String", # Output only. Timestamp when this deployment was created.
"displayName": "A String", # Required. Display name of the deployment.
"etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
"name": "A String", # Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
"updateTime": "A String", # Output only. Timestamp when this deployment was last updated.
}
deploymentId: string, Optional. The ID to use for the deployment, which will become the final component of the deployment's resource name. If not provided, a unique ID will be automatically assigned for the deployment.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.
"appVersion": "A String", # Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
"channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment.
"channelType": "A String", # Optional. The type of the channel profile.
"disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt.
"disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency).
"noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high".
"personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile.
"persona": "A String", # Optional. The persona of the channel.
},
"profileId": "A String", # Optional. The unique identifier of the channel profile.
"webWidgetConfig": { # Message for configuration for the web widget. # Optional. The configuration for the web widget.
"modality": "A String", # Optional. The modality of the web widget.
"securitySettings": { # Security settings for the web widget. # Optional. The security settings of the web widget.
"allowedOrigins": [ # Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"
"A String",
],
"enableOriginCheck": True or False, # Optional. Indicates whether origin check for the web widget is enabled. If `true`, the web widget will check the origin of the website that loads the web widget and only allow it to be loaded in the same origin or any of the allowed origins.
"enablePublicAccess": True or False, # Optional. Indicates whether public access to the web widget is enabled. If `true`, the web widget will be publicly accessible. If `false`, the web widget must be integrated with your own authentication and authorization system to return valid credentials for accessing the CES agent.
"enableRecaptcha": True or False, # Optional. Indicates whether reCAPTCHA verification for the web widget is enabled.
},
"theme": "A String", # Optional. The theme of the web widget.
"webWidgetTitle": "A String", # Optional. The title of the web widget.
},
},
"createTime": "A String", # Output only. Timestamp when this deployment was created.
"displayName": "A String", # Required. Display name of the deployment.
"etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
"name": "A String", # Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
"updateTime": "A String", # Output only. Timestamp when this deployment was last updated.
}
delete(name, etag=None, x__xgafv=None)
Deletes the specified deployment.
Args:
name: string, Required. The name of the deployment to delete. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` (required)
etag: string, Optional. The etag of the deployment. If an etag is provided and does not match the current etag of the deployment, deletion will be blocked and an ABORTED error will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
get(name, x__xgafv=None)
Gets details of the specified deployment.
Args:
name: string, Required. The name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.
"appVersion": "A String", # Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
"channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment.
"channelType": "A String", # Optional. The type of the channel profile.
"disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt.
"disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency).
"noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high".
"personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile.
"persona": "A String", # Optional. The persona of the channel.
},
"profileId": "A String", # Optional. The unique identifier of the channel profile.
"webWidgetConfig": { # Message for configuration for the web widget. # Optional. The configuration for the web widget.
"modality": "A String", # Optional. The modality of the web widget.
"securitySettings": { # Security settings for the web widget. # Optional. The security settings of the web widget.
"allowedOrigins": [ # Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"
"A String",
],
"enableOriginCheck": True or False, # Optional. Indicates whether origin check for the web widget is enabled. If `true`, the web widget will check the origin of the website that loads the web widget and only allow it to be loaded in the same origin or any of the allowed origins.
"enablePublicAccess": True or False, # Optional. Indicates whether public access to the web widget is enabled. If `true`, the web widget will be publicly accessible. If `false`, the web widget must be integrated with your own authentication and authorization system to return valid credentials for accessing the CES agent.
"enableRecaptcha": True or False, # Optional. Indicates whether reCAPTCHA verification for the web widget is enabled.
},
"theme": "A String", # Optional. The theme of the web widget.
"webWidgetTitle": "A String", # Optional. The title of the web widget.
},
},
"createTime": "A String", # Output only. Timestamp when this deployment was created.
"displayName": "A String", # Required. Display name of the deployment.
"etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
"name": "A String", # Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
"updateTime": "A String", # Output only. Timestamp when this deployment was last updated.
}
list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists deployments in the given app.
Args:
parent: string, Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}` (required)
orderBy: string, Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
pageSize: integer, Optional. The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A page token, received from a previous `ListDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeployments` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for AgentService.ListDeployments.
"deployments": [ # The list of deployments.
{ # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.
"appVersion": "A String", # Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
"channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment.
"channelType": "A String", # Optional. The type of the channel profile.
"disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt.
"disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency).
"noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high".
"personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile.
"persona": "A String", # Optional. The persona of the channel.
},
"profileId": "A String", # Optional. The unique identifier of the channel profile.
"webWidgetConfig": { # Message for configuration for the web widget. # Optional. The configuration for the web widget.
"modality": "A String", # Optional. The modality of the web widget.
"securitySettings": { # Security settings for the web widget. # Optional. The security settings of the web widget.
"allowedOrigins": [ # Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"
"A String",
],
"enableOriginCheck": True or False, # Optional. Indicates whether origin check for the web widget is enabled. If `true`, the web widget will check the origin of the website that loads the web widget and only allow it to be loaded in the same origin or any of the allowed origins.
"enablePublicAccess": True or False, # Optional. Indicates whether public access to the web widget is enabled. If `true`, the web widget will be publicly accessible. If `false`, the web widget must be integrated with your own authentication and authorization system to return valid credentials for accessing the CES agent.
"enableRecaptcha": True or False, # Optional. Indicates whether reCAPTCHA verification for the web widget is enabled.
},
"theme": "A String", # Optional. The theme of the web widget.
"webWidgetTitle": "A String", # Optional. The title of the web widget.
},
},
"createTime": "A String", # Output only. Timestamp when this deployment was created.
"displayName": "A String", # Required. Display name of the deployment.
"etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
"name": "A String", # Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
"updateTime": "A String", # Output only. Timestamp when this deployment was last updated.
},
],
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the specified deployment.
Args:
name: string, Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} (required)
body: object, The request body.
The object takes the form of:
{ # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.
"appVersion": "A String", # Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
"channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment.
"channelType": "A String", # Optional. The type of the channel profile.
"disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt.
"disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency).
"noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high".
"personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile.
"persona": "A String", # Optional. The persona of the channel.
},
"profileId": "A String", # Optional. The unique identifier of the channel profile.
"webWidgetConfig": { # Message for configuration for the web widget. # Optional. The configuration for the web widget.
"modality": "A String", # Optional. The modality of the web widget.
"securitySettings": { # Security settings for the web widget. # Optional. The security settings of the web widget.
"allowedOrigins": [ # Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"
"A String",
],
"enableOriginCheck": True or False, # Optional. Indicates whether origin check for the web widget is enabled. If `true`, the web widget will check the origin of the website that loads the web widget and only allow it to be loaded in the same origin or any of the allowed origins.
"enablePublicAccess": True or False, # Optional. Indicates whether public access to the web widget is enabled. If `true`, the web widget will be publicly accessible. If `false`, the web widget must be integrated with your own authentication and authorization system to return valid credentials for accessing the CES agent.
"enableRecaptcha": True or False, # Optional. Indicates whether reCAPTCHA verification for the web widget is enabled.
},
"theme": "A String", # Optional. The theme of the web widget.
"webWidgetTitle": "A String", # Optional. The title of the web widget.
},
},
"createTime": "A String", # Output only. Timestamp when this deployment was created.
"displayName": "A String", # Required. Display name of the deployment.
"etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
"name": "A String", # Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
"updateTime": "A String", # Output only. Timestamp when this deployment was last updated.
}
updateMask: string, Optional. The list of fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.
"appVersion": "A String", # Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
"channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment.
"channelType": "A String", # Optional. The type of the channel profile.
"disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt.
"disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency).
"noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high".
"personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile.
"persona": "A String", # Optional. The persona of the channel.
},
"profileId": "A String", # Optional. The unique identifier of the channel profile.
"webWidgetConfig": { # Message for configuration for the web widget. # Optional. The configuration for the web widget.
"modality": "A String", # Optional. The modality of the web widget.
"securitySettings": { # Security settings for the web widget. # Optional. The security settings of the web widget.
"allowedOrigins": [ # Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"
"A String",
],
"enableOriginCheck": True or False, # Optional. Indicates whether origin check for the web widget is enabled. If `true`, the web widget will check the origin of the website that loads the web widget and only allow it to be loaded in the same origin or any of the allowed origins.
"enablePublicAccess": True or False, # Optional. Indicates whether public access to the web widget is enabled. If `true`, the web widget will be publicly accessible. If `false`, the web widget must be integrated with your own authentication and authorization system to return valid credentials for accessing the CES agent.
"enableRecaptcha": True or False, # Optional. Indicates whether reCAPTCHA verification for the web widget is enabled.
},
"theme": "A String", # Optional. The theme of the web widget.
"webWidgetTitle": "A String", # Optional. The title of the web widget.
},
},
"createTime": "A String", # Output only. Timestamp when this deployment was created.
"displayName": "A String", # Required. Display name of the deployment.
"etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
"name": "A String", # Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
"updateTime": "A String", # Output only. Timestamp when this deployment was last updated.
}