CloudControlsPartnerCoreAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.cloudcontrolspartner_v1.services.cloud_controls_partner_core.transports.base.CloudControlsPartnerCoreTransport] = 'grpc_asyncio', client_options: typing.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 describing handlers for resources
Properties
api_endpoint
Return the API endpoint used by the client instance.
Returns | |
---|---|
Type | Description |
str |
The API endpoint used by the client instance. |
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
CloudControlsPartnerCoreTransport |
The transport used by the client instance. |
universe_domain
Return the universe domain used by the client instance.
Returns | |
---|---|
Type | Description |
str |
The universe domain used by the client instance. |
Methods
CloudControlsPartnerCoreAsyncClient
CloudControlsPartnerCoreAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.cloudcontrolspartner_v1.services.cloud_controls_partner_core.transports.base.CloudControlsPartnerCoreTransport] = 'grpc_asyncio', client_options: typing.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 cloud controls partner core async 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,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
Optional[Union[google.api_core.client_options.ClientOptions, dict]]
Custom options for the client. 1. The |
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. |
access_approval_request_path
access_approval_request_path(
organization: str,
location: str,
customer: str,
workload: str,
access_approval_request: str,
) -> str
Returns a fully-qualified access_approval_request string.
common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
customer_path
customer_path(organization: str, location: str, customer: str) -> str
Returns a fully-qualified customer string.
ekm_connections_path
ekm_connections_path(
organization: str, location: str, customer: str, workload: str
) -> str
Returns a fully-qualified ekm_connections 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 |
CloudControlsPartnerCoreAsyncClient |
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 |
CloudControlsPartnerCoreAsyncClient |
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 |
CloudControlsPartnerCoreAsyncClient |
The constructed client. |
get_customer
get_customer(
request: typing.Optional[
typing.Union[
google.cloud.cloudcontrolspartner_v1.types.customers.GetCustomerRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.cloudcontrolspartner_v1.types.customers.Customer
Gets details of a single customer
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import cloudcontrolspartner_v1
async def sample_get_customer():
# Create a client
client = cloudcontrolspartner_v1.CloudControlsPartnerCoreAsyncClient()
# Initialize request argument(s)
request = cloudcontrolspartner_v1.GetCustomerRequest(
name="name_value",
)
# Make the request
response = await client.get_customer(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.cloudcontrolspartner_v1.types.GetCustomerRequest, dict]]
The request object. Message for getting a customer |
name |
Required. Format: |
retry |
google.api_core.retry_async.AsyncRetry
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.cloudcontrolspartner_v1.types.Customer |
Contains metadata around a Cloud Controls Partner Customer |
get_ekm_connections
get_ekm_connections(
request: typing.Optional[
typing.Union[
google.cloud.cloudcontrolspartner_v1.types.ekm_connections.GetEkmConnectionsRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.cloudcontrolspartner_v1.types.ekm_connections.EkmConnections
Gets the EKM connections associated with a workload
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import cloudcontrolspartner_v1
async def sample_get_ekm_connections():
# Create a client
client = cloudcontrolspartner_v1.CloudControlsPartnerCoreAsyncClient()
# Initialize request argument(s)
request = cloudcontrolspartner_v1.GetEkmConnectionsRequest(
name="name_value",
)
# Make the request
response = await client.get_ekm_connections(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.cloudcontrolspartner_v1.types.GetEkmConnectionsRequest, dict]]
The request object. Request for getting the EKM connections associated with a workload |
name |
Required. Format: |
retry |
google.api_core.retry_async.AsyncRetry
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.cloudcontrolspartner_v1.types.EkmConnections |
The EKM connections associated with a workload |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.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 variable 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.
Parameter | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError |
If any errors happen. |
Returns | |
---|---|
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] |
returns the API endpoint and the client cert source to use. |
get_partner
get_partner(
request: typing.Optional[
typing.Union[
google.cloud.cloudcontrolspartner_v1.types.partners.GetPartnerRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.cloudcontrolspartner_v1.types.partners.Partner
Get details of a Partner.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import cloudcontrolspartner_v1
async def sample_get_partner():
# Create a client
client = cloudcontrolspartner_v1.CloudControlsPartnerCoreAsyncClient()
# Initialize request argument(s)
request = cloudcontrolspartner_v1.GetPartnerRequest(
name="name_value",
)
# Make the request
response = await client.get_partner(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.cloudcontrolspartner_v1.types.GetPartnerRequest, dict]]
The request object. Message for getting a Partner |
name |
Required. Format: |
retry |
google.api_core.retry_async.AsyncRetry
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.cloudcontrolspartner_v1.types.Partner |
Message describing Partner resource |
get_partner_permissions
get_partner_permissions(
request: typing.Optional[
typing.Union[
google.cloud.cloudcontrolspartner_v1.types.partner_permissions.GetPartnerPermissionsRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.cloudcontrolspartner_v1.types.partner_permissions.PartnerPermissions
Gets the partner permissions granted for a workload
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import cloudcontrolspartner_v1
async def sample_get_partner_permissions():
# Create a client
client = cloudcontrolspartner_v1.CloudControlsPartnerCoreAsyncClient()
# Initialize request argument(s)
request = cloudcontrolspartner_v1.GetPartnerPermissionsRequest(
name="name_value",
)
# Make the request
response = await client.get_partner_permissions(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.cloudcontrolspartner_v1.types.GetPartnerPermissionsRequest, dict]]
The request object. Request for getting the partner permissions granted for a workload |
name |
Required. Name of the resource to get in the format: |
retry |
google.api_core.retry_async.AsyncRetry
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.cloudcontrolspartner_v1.types.PartnerPermissions |
The permissions granted to the partner for a workload |
get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.cloudcontrolspartner_v1.services.cloud_controls_partner_core.transports.base.CloudControlsPartnerCoreTransport
]
)
Returns an appropriate transport class.
Parameter | |
---|---|
Name | Description |
label |
typing.Optional[str]
The name of the desired transport. If none is provided, then the first transport in the registry is used. |
get_workload
get_workload(
request: typing.Optional[
typing.Union[
google.cloud.cloudcontrolspartner_v1.types.customer_workloads.GetWorkloadRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.cloudcontrolspartner_v1.types.customer_workloads.Workload
Gets details of a single workload
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import cloudcontrolspartner_v1
async def sample_get_workload():
# Create a client
client = cloudcontrolspartner_v1.CloudControlsPartnerCoreAsyncClient()
# Initialize request argument(s)
request = cloudcontrolspartner_v1.GetWorkloadRequest(
name="name_value",
)
# Make the request
response = await client.get_workload(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.cloudcontrolspartner_v1.types.GetWorkloadRequest, dict]]
The request object. Message for getting a customer workload. |
name |
Required. Format: |
retry |
google.api_core.retry_async.AsyncRetry
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.cloudcontrolspartner_v1.types.Workload |
Contains metadata around the [Workload resource](\ https://cloud.google.com/assured-workloads/docs/reference/rest/Shared.Types/Workload) in the Assured Workloads API. |
list_access_approval_requests
list_access_approval_requests(
request: typing.Optional[
typing.Union[
google.cloud.cloudcontrolspartner_v1.types.access_approval_requests.ListAccessApprovalRequestsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.cloudcontrolspartner_v1.services.cloud_controls_partner_core.pagers.ListAccessApprovalRequestsAsyncPager
)
Lists access requests associated with a workload
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import cloudcontrolspartner_v1
async def sample_list_access_approval_requests():
# Create a client
client = cloudcontrolspartner_v1.CloudControlsPartnerCoreAsyncClient()
# Initialize request argument(s)
request = cloudcontrolspartner_v1.ListAccessApprovalRequestsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_access_approval_requests(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.cloudcontrolspartner_v1.types.ListAccessApprovalRequestsRequest, dict]]
The request object. Request for getting the access requests associated with a workload. |
parent |
Required. Parent resource Format: |
retry |
google.api_core.retry_async.AsyncRetry
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.cloudcontrolspartner_v1.services.cloud_controls_partner_core.pagers.ListAccessApprovalRequestsAsyncPager |
Response message for list access requests. Iterating over this object will yield results and resolve additional pages automatically. |
list_customers
list_customers(
request: typing.Optional[
typing.Union[
google.cloud.cloudcontrolspartner_v1.types.customers.ListCustomersRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.cloudcontrolspartner_v1.services.cloud_controls_partner_core.pagers.ListCustomersAsyncPager
)
Lists customers of a partner identified by its Google Cloud organization ID
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import cloudcontrolspartner_v1
async def sample_list_customers():
# Create a client
client = cloudcontrolspartner_v1.CloudControlsPartnerCoreAsyncClient()
# Initialize request argument(s)
request = cloudcontrolspartner_v1.ListCustomersRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_customers(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.cloudcontrolspartner_v1.types.ListCustomersRequest, dict]]
The request object. Request to list customers |
parent |
Required. Parent resource Format: |
retry |
google.api_core.retry_async.AsyncRetry
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.cloudcontrolspartner_v1.services.cloud_controls_partner_core.pagers.ListCustomersAsyncPager |
Response message for list customer Customers requests Iterating over this object will yield results and resolve additional pages automatically. |
list_workloads
list_workloads(
request: typing.Optional[
typing.Union[
google.cloud.cloudcontrolspartner_v1.types.customer_workloads.ListWorkloadsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.cloudcontrolspartner_v1.services.cloud_controls_partner_core.pagers.ListWorkloadsAsyncPager
)
Lists customer workloads for a given customer org id
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import cloudcontrolspartner_v1
async def sample_list_workloads():
# Create a client
client = cloudcontrolspartner_v1.CloudControlsPartnerCoreAsyncClient()
# Initialize request argument(s)
request = cloudcontrolspartner_v1.ListWorkloadsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_workloads(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.cloudcontrolspartner_v1.types.ListWorkloadsRequest, dict]]
The request object. Request to list customer workloads. |
parent |
Required. Parent resource Format: |
retry |
google.api_core.retry_async.AsyncRetry
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.cloudcontrolspartner_v1.services.cloud_controls_partner_core.pagers.ListWorkloadsAsyncPager |
Response message for list customer workloads requests. Iterating over this object will yield results and resolve additional pages automatically. |
parse_access_approval_request_path
parse_access_approval_request_path(path: str) -> typing.Dict[str, str]
Parses a access_approval_request path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
parse_customer_path
parse_customer_path(path: str) -> typing.Dict[str, str]
Parses a customer path into its component segments.
parse_ekm_connections_path
parse_ekm_connections_path(path: str) -> typing.Dict[str, str]
Parses a ekm_connections path into its component segments.
parse_partner_path
parse_partner_path(path: str) -> typing.Dict[str, str]
Parses a partner path into its component segments.
parse_partner_permissions_path
parse_partner_permissions_path(path: str) -> typing.Dict[str, str]
Parses a partner_permissions path into its component segments.
parse_workload_path
parse_workload_path(path: str) -> typing.Dict[str, str]
Parses a workload path into its component segments.
partner_path
partner_path(organization: str, location: str) -> str
Returns a fully-qualified partner string.
partner_permissions_path
partner_permissions_path(
organization: str, location: str, customer: str, workload: str
) -> str
Returns a fully-qualified partner_permissions string.
workload_path
workload_path(
organization: str, location: str, customer: str, workload: str
) -> str
Returns a fully-qualified workload string.