DeploymentsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.deployments.transports.base.DeploymentsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Service for managing Deployments.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
DeploymentsTransport | The transport used by the client instance. |
Methods
DeploymentsClient
DeploymentsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.deployments.transports.base.DeploymentsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the deployments client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, DeploymentsTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
deployment_path
deployment_path(
project: str, location: str, agent: str, environment: str, deployment: str
)
Returns a fully-qualified deployment string.
experiment_path
experiment_path(
project: str, location: str, agent: str, environment: str, experiment: str
)
Returns a fully-qualified experiment string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
DeploymentsClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
DeploymentsClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
DeploymentsClient | The constructed client. |
get_deployment
get_deployment(request: Optional[Union[google.cloud.dialogflowcx_v3.types.deployment.GetDeploymentRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves the specified xref_Deployment.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3.types.GetDeploymentRequest, dict]
The request object. The request message for Deployments.GetDeployment. |
name |
str
Required. The name of the Deployment. Format: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.dialogflowcx_v3.types.Deployment | Represents an deployment in an environment. A deployment happens when a flow version configured to be active in the environment. You can configure running pre-deployment steps, e.g. running validation test cases, experiment auto-rollout, etc. |
list_deployments
list_deployments(request: Optional[Union[google.cloud.dialogflowcx_v3.types.deployment.ListDeploymentsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns the list of all deployments in the specified xref_Environment.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3.types.ListDeploymentsRequest, dict]
The request object. The request message for Deployments.ListDeployments. |
parent |
str
Required. The Environment to list all environments for. Format: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.dialogflowcx_v3.services.deployments.pagers.ListDeploymentsPager | The response message for Deployments.ListDeployments. Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_deployment_path
parse_deployment_path(path: str)
Parses a deployment path into its component segments.
parse_experiment_path
parse_experiment_path(path: str)
Parses a experiment path into its component segments.
parse_test_case_result_path
parse_test_case_result_path(path: str)
Parses a test_case_result path into its component segments.
parse_version_path
parse_version_path(path: str)
Parses a version path into its component segments.
test_case_result_path
test_case_result_path(
project: str, location: str, agent: str, test_case: str, result: str
)
Returns a fully-qualified test_case_result string.
version_path
version_path(project: str, location: str, agent: str, flow: str, version: str)
Returns a fully-qualified version string.