Google Cloud Assured Workloads V1beta1 Client - Class AssuredWorkloadsServiceClient (0.7.3)

Reference documentation and code samples for the Google Cloud Assured Workloads V1beta1 Client class AssuredWorkloadsServiceClient.

Service Description: Service to manage AssuredWorkloads.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$assuredWorkloadsServiceClient = new AssuredWorkloadsServiceClient();
try {
    $formattedParent = $assuredWorkloadsServiceClient->locationName('[ORGANIZATION]', '[LOCATION]');
    $workload = new Workload();
    $operationResponse = $assuredWorkloadsServiceClient->createWorkload($formattedParent, $workload);
    $operationResponse->pollUntilComplete();
    if ($operationResponse->operationSucceeded()) {
        $result = $operationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $operationResponse->getError();
        // handleError($error)
    }
    // Alternatively:
    // start the operation, keep the operation name, and resume later
    $operationResponse = $assuredWorkloadsServiceClient->createWorkload($formattedParent, $workload);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $assuredWorkloadsServiceClient->resumeOperation($operationName, 'createWorkload');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        $result = $newOperationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $assuredWorkloadsServiceClient->close();
}

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Methods

locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
NameDescription
organization string
location string
Returns
TypeDescription
stringThe formatted location resource.

workloadName

Formats a string containing the fully-qualified path to represent a workload resource.

Parameters
NameDescription
organization string
location string
workload string
Returns
TypeDescription
stringThe formatted workload resource.

parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

  • location: organizations/{organization}/locations/{location}
  • workload: organizations/{organization}/locations/{location}/workloads/{workload}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
NameDescription
formattedName string

The formatted name string

template string

Optional name of template to match

Returns
TypeDescription
arrayAn associative array from name component IDs to component values.

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
TypeDescription
Google\ApiCore\LongRunning\OperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
NameDescription
operationName string

The name of the long running operation

methodName string

The name of the method used to start the operation

Returns
TypeDescription
Google\ApiCore\OperationResponse

__construct

Constructor.

Parameters
NameDescription
options array

Optional. Options for configuring the service API wrapper.

↳ serviceAddress string

Deprecated. This option will be removed in a future major release. Please utilize the $apiEndpoint option instead.

↳ apiEndpoint string

The address of the API remote host. May optionally include the port, formatted as "

↳ credentials string|array|FetchAuthTokenInterface|CredentialsWrapper

The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.

↳ credentialsConfig array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .

↳ disableRetries bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.

↳ clientConfig string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.

↳ transport string|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $serviceAddress setting, will be ignored.

↳ transportConfig array

Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.

↳ clientCertSource callable

A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createWorkload

Creates Assured Workload.

Sample code:

$assuredWorkloadsServiceClient = new AssuredWorkloadsServiceClient();
try {
    $formattedParent = $assuredWorkloadsServiceClient->locationName('[ORGANIZATION]', '[LOCATION]');
    $workload = new Workload();
    $operationResponse = $assuredWorkloadsServiceClient->createWorkload($formattedParent, $workload);
    $operationResponse->pollUntilComplete();
    if ($operationResponse->operationSucceeded()) {
        $result = $operationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $operationResponse->getError();
        // handleError($error)
    }
    // Alternatively:
    // start the operation, keep the operation name, and resume later
    $operationResponse = $assuredWorkloadsServiceClient->createWorkload($formattedParent, $workload);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $assuredWorkloadsServiceClient->resumeOperation($operationName, 'createWorkload');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        $result = $newOperationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $assuredWorkloadsServiceClient->close();
}
Parameters
NameDescription
parent string

Required. The resource name of the new Workload's parent. Must be of the form organizations/{org_id}/locations/{location_id}.

workload Google\Cloud\AssuredWorkloads\V1beta1\Workload

Required. Assured Workload to create

optionalArgs array

Optional.

↳ externalId string

Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\Cloud\AssuredWorkloads\V1beta1\Gapic\Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\Cloud\AssuredWorkloads\V1beta1\Gapic\Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\OperationResponse

deleteWorkload

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.

Sample code:

$assuredWorkloadsServiceClient = new AssuredWorkloadsServiceClient();
try {
    $formattedName = $assuredWorkloadsServiceClient->workloadName('[ORGANIZATION]', '[LOCATION]', '[WORKLOAD]');
    $assuredWorkloadsServiceClient->deleteWorkload($formattedName);
} finally {
    $assuredWorkloadsServiceClient->close();
}
Parameters
NameDescription
name string

Required. The name field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}

optionalArgs array

Optional.

↳ etag string

Optional. The etag of the workload. If this is provided, it must match the server's etag.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\Cloud\AssuredWorkloads\V1beta1\Gapic\Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\Cloud\AssuredWorkloads\V1beta1\Gapic\Google\ApiCore\RetrySettings for example usage.

getWorkload

Gets Assured Workload associated with a CRM Node

Sample code:

$assuredWorkloadsServiceClient = new AssuredWorkloadsServiceClient();
try {
    $formattedName = $assuredWorkloadsServiceClient->workloadName('[ORGANIZATION]', '[LOCATION]', '[WORKLOAD]');
    $response = $assuredWorkloadsServiceClient->getWorkload($formattedName);
} finally {
    $assuredWorkloadsServiceClient->close();
}
Parameters
NameDescription
name string

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".

optionalArgs array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\Cloud\AssuredWorkloads\V1beta1\Gapic\Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\Cloud\AssuredWorkloads\V1beta1\Gapic\Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\AssuredWorkloads\V1beta1\Workload

listWorkloads

Lists Assured Workloads under a CRM Node.

Sample code:

$assuredWorkloadsServiceClient = new AssuredWorkloadsServiceClient();
try {
    $formattedParent = $assuredWorkloadsServiceClient->locationName('[ORGANIZATION]', '[LOCATION]');
    // Iterate over pages of elements
    $pagedResponse = $assuredWorkloadsServiceClient->listWorkloads($formattedParent);
    foreach ($pagedResponse->iteratePages() as $page) {
        foreach ($page as $element) {
            // doSomethingWith($element);
        }
    }
    // Alternatively:
    // Iterate through all elements
    $pagedResponse = $assuredWorkloadsServiceClient->listWorkloads($formattedParent);
    foreach ($pagedResponse->iterateAllElements() as $element) {
        // doSomethingWith($element);
    }
} finally {
    $assuredWorkloadsServiceClient->close();
}
Parameters
NameDescription
parent string

Required. Parent Resource to list workloads from. Must be of the form organizations/{org_id}/locations/{location}.

optionalArgs array

Optional.

↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.

↳ pageToken string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.

↳ filter string

A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\Cloud\AssuredWorkloads\V1beta1\Gapic\Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\Cloud\AssuredWorkloads\V1beta1\Gapic\Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\PagedListResponse

updateWorkload

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.

Sample code:

$assuredWorkloadsServiceClient = new AssuredWorkloadsServiceClient();
try {
    $workload = new Workload();
    $updateMask = new FieldMask();
    $response = $assuredWorkloadsServiceClient->updateWorkload($workload, $updateMask);
} finally {
    $assuredWorkloadsServiceClient->close();
}
Parameters
NameDescription
workload Google\Cloud\AssuredWorkloads\V1beta1\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}

updateMask Google\Protobuf\FieldMask

Required. The list of fields to be updated.

optionalArgs array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\Cloud\AssuredWorkloads\V1beta1\Gapic\Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\Cloud\AssuredWorkloads\V1beta1\Gapic\Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\AssuredWorkloads\V1beta1\Workload

Constants

SERVICE_NAME

Value: 'google.cloud.assuredworkloads.v1beta1.AssuredWorkloadsService'

The name of the service.

SERVICE_ADDRESS

Value: 'assuredworkloads.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.