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.
| 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.
| 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 |
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 |
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)Releases underlying transport's resources.
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[Union[google.cloud.assuredworkloads_v1beta1.types.assuredworkloads.CreateWorkloadRequest, dict]] = None, *, parent: Optional[str] = None, workload: Optional[google.cloud.assuredworkloads_v1beta1.types.assuredworkloads.Workload] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates Assured Workload.
from google.cloud import assuredworkloads_v1beta1
def sample_create_workload():
# Create a client
client = assuredworkloads_v1beta1.AssuredWorkloadsServiceClient()
# Initialize request argument(s)
workload = assuredworkloads_v1beta1.Workload()
workload.display_name = "display_name_value"
workload.compliance_regime = "ITAR"
request = assuredworkloads_v1beta1.CreateWorkloadRequest(
parent="parent_value",
workload=workload,
)
# Make the request
operation = client.create_workload(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.assuredworkloads_v1beta1.types.CreateWorkloadRequest, dict]
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 |
workload |
google.cloud.assuredworkloads_v1beta1.types.Workload
Required. Assured Workload to create This corresponds to the |
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. |
| 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[Union[google.cloud.assuredworkloads_v1beta1.types.assuredworkloads.DeleteWorkloadRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
from google.cloud import assuredworkloads_v1beta1
def sample_delete_workload():
# Create a client
client = assuredworkloads_v1beta1.AssuredWorkloadsServiceClient()
# Initialize request argument(s)
request = assuredworkloads_v1beta1.DeleteWorkloadRequest(
name="name_value",
)
# Make the request
client.delete_workload(request=request)
| Name | Description |
request |
Union[google.cloud.assuredworkloads_v1beta1.types.DeleteWorkloadRequest, dict]
The request object. Request for deleting a Workload. |
name |
str
Required. The |
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.
| Name | Description |
filename |
str
The path to the service account private key json file. |
| 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.
| Name | Description |
info |
dict
The service account private key info. |
| 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.
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Type | Description |
AssuredWorkloadsServiceClient | The constructed client. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
| Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_workload
get_workload(request: Optional[Union[google.cloud.assuredworkloads_v1beta1.types.assuredworkloads.GetWorkloadRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets Assured Workload associated with a CRM Node
from google.cloud import assuredworkloads_v1beta1
def sample_get_workload():
# Create a client
client = assuredworkloads_v1beta1.AssuredWorkloadsServiceClient()
# Initialize request argument(s)
request = assuredworkloads_v1beta1.GetWorkloadRequest(
name="name_value",
)
# Make the request
response = client.get_workload(request=request)
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.assuredworkloads_v1beta1.types.GetWorkloadRequest, dict]
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 |
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. |
| 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[Union[google.cloud.assuredworkloads_v1beta1.types.assuredworkloads.ListWorkloadsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists Assured Workloads under a CRM Node.
from google.cloud import assuredworkloads_v1beta1
def sample_list_workloads():
# Create a client
client = assuredworkloads_v1beta1.AssuredWorkloadsServiceClient()
# Initialize request argument(s)
request = assuredworkloads_v1beta1.ListWorkloadsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_workloads(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
request |
Union[google.cloud.assuredworkloads_v1beta1.types.ListWorkloadsRequest, dict]
The request object. Request for fetching workloads in an organization. |
parent |
str
Required. Parent Resource to list workloads from. Must be of the form |
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. |
| 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[Union[google.cloud.assuredworkloads_v1beta1.types.assuredworkloads.UpdateWorkloadRequest, dict]] = None, *, workload: Optional[google.cloud.assuredworkloads_v1beta1.types.assuredworkloads.Workload] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
from google.cloud import assuredworkloads_v1beta1
def sample_update_workload():
# Create a client
client = assuredworkloads_v1beta1.AssuredWorkloadsServiceClient()
# Initialize request argument(s)
workload = assuredworkloads_v1beta1.Workload()
workload.display_name = "display_name_value"
workload.compliance_regime = "ITAR"
request = assuredworkloads_v1beta1.UpdateWorkloadRequest(
workload=workload,
)
# Make the request
response = client.update_workload(request=request)
# Handle the response
print(response)
| Name | Description |
request |
Union[google.cloud.assuredworkloads_v1beta1.types.UpdateWorkloadRequest, dict]
The request object. Request for Updating a workload. |
workload |
google.cloud.assuredworkloads_v1beta1.types.Workload
Required. The workload to update. The workload’s |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Required. The list of fields to be updated. This corresponds to the |
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. |
| 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.