Class AssuredWorkloadsServiceClient (0.3.1)

AssuredWorkloadsServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.assuredworkloads_v1beta1.services.assured_workloads_service.transports.base.AssuredWorkloadsServiceTransport]] = 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 to manage AssuredWorkloads.

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
`AssuredWorkloadsServiceTransport`	The transport used by the client instance.

Methods

AssuredWorkloadsServiceClient

AssuredWorkloadsServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.assuredworkloads_v1beta1.services.assured_workloads_service.transports.base.AssuredWorkloadsServiceTransport]] = 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 assured workloads service 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, AssuredWorkloadsServiceTransport]` 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 `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
`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 `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

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.

create_workload

create_workload(request: Optional[google.cloud.assuredworkloads_v1beta1.types.assuredworkloads_v1beta1.CreateWorkloadRequest] = None, *, parent: Optional[str] = None, workload: Optional[google.cloud.assuredworkloads_v1beta1.types.assuredworkloads_v1beta1.Workload] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates Assured Workload.

Parameters

Name	Description
`request`	`google.cloud.assuredworkloads_v1beta1.types.CreateWorkloadRequest` The request object. Request for creating a workload.
`parent`	`str` Required. The resource name of the new Workload's parent. Must be of the form `organizations/{org_id}/locations/{location_id}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`workload`	`google.cloud.assuredworkloads_v1beta1.types.Workload` Required. Assured Workload to create This corresponds to the `workload` field on the `request` instance; if `request` is provided, this should not be set.
`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.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be Workload An Workload object for managing highly regulated workloads of cloud customers.

delete_workload

delete_workload(request: Optional[google.cloud.assuredworkloads_v1beta1.types.assuredworkloads_v1beta1.DeleteWorkloadRequest] = 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]] = ())

Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error.

Parameters

Name	Description
`request`	`google.cloud.assuredworkloads_v1beta1.types.DeleteWorkloadRequest` The request object. Request for deleting a Workload.
`name`	`str` Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id} This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`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.

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
`AssuredWorkloadsServiceClient`	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
`AssuredWorkloadsServiceClient`	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
`AssuredWorkloadsServiceClient`	The constructed client.

get_workload

get_workload(request: Optional[google.cloud.assuredworkloads_v1beta1.types.assuredworkloads_v1beta1.GetWorkloadRequest] = 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]] = ())

Gets Assured Workload associated with a CRM Node

Parameters

Name	Description
`request`	`google.cloud.assuredworkloads_v1beta1.types.GetWorkloadRequest` The request object. Request for fetching a workload.
`name`	`str` Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as "organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}". For example, "organizations/123/locations/us-east1/workloads/assured-workload-1". This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`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.assuredworkloads_v1beta1.types.Workload`	An Workload object for managing highly regulated workloads of cloud customers.

list_workloads

list_workloads(request: Optional[google.cloud.assuredworkloads_v1beta1.types.assuredworkloads_v1beta1.ListWorkloadsRequest] = 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]] = ())

Lists Assured Workloads under a CRM Node.

Parameters

Name	Description
`request`	`google.cloud.assuredworkloads_v1beta1.types.ListWorkloadsRequest` The request object. Request for fetching workloads in an organization.
`parent`	`str` Required. Parent Resource to list workloads from. Must be of the form `organizations/{org_id}/locations/{location}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`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.assuredworkloads_v1beta1.services.assured_workloads_service.pagers.ListWorkloadsPager`	Response of ListWorkloads endpoint. 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_workload_path

parse_workload_path(path: str)

Parses a workload path into its component segments.

update_workload

update_workload(request: Optional[google.cloud.assuredworkloads_v1beta1.types.assuredworkloads_v1beta1.UpdateWorkloadRequest] = None, *, workload: Optional[google.cloud.assuredworkloads_v1beta1.types.assuredworkloads_v1beta1.Workload] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.

Parameters

Name	Description
`request`	`google.cloud.assuredworkloads_v1beta1.types.UpdateWorkloadRequest` The request object. Request for Updating a workload.
`workload`	`google.cloud.assuredworkloads_v1beta1.types.Workload` Required. The workload to update. The workload’s `name` field is used to identify the workload to be updated. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id} This corresponds to the `workload` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Required. The list of fields to be updated. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`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.assuredworkloads_v1beta1.types.Workload`	An Workload object for managing highly regulated workloads of cloud customers.

workload_path

workload_path(organization: str, location: str, workload: str)

Returns a fully-qualified workload string.