Reference documentation and code samples for the Google Anthos Multi Cloud V1 Client class AwsClustersClient.
Service Description: The AwsClusters API provides a single centrally managed service to create and manage Anthos clusters that run on AWS infrastructure.
This class is currently experimental and may be subject to changes.
Methods
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
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.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
awsClusterName
Formats a string containing the fully-qualified path to represent a aws_cluster resource.
project
string
location
string
awsCluster
string
string
awsNodePoolName
Formats a string containing the fully-qualified path to represent a aws_node_pool resource.
project
string
location
string
awsCluster
string
awsNodePool
string
string
awsServerConfigName
Formats a string containing the fully-qualified path to represent a aws_server_config resource.
project
string
location
string
string
locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
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
- awsCluster: projects/{project}/locations/{location}/awsClusters/{aws_cluster}
- awsNodePool: projects/{project}/locations/{location}/awsClusters/{aws_cluster}/awsNodePools/{aws_node_pool}
- awsServerConfig: projects/{project}/locations/{location}/awsServerConfig
- location: projects/{project}/locations/{location}
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.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
__construct
Constructor.
options
array
Optional. Options for configuring the service API wrapper.
↳ 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 $apiEndpoint 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.
__call
Handles execution of the async variants for each documented method.
method
mixed
args
mixed
createAwsCluster
Creates a new AwsCluster resource on a given Google Cloud Platform project and region.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
The async variant is Google\Cloud\GkeMultiCloud\V1\Client\BaseClient\self::createAwsClusterAsync() .
request
Google\Cloud\GkeMultiCloud\V1\CreateAwsClusterRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
createAwsNodePool
Creates a new AwsNodePool , attached to a given AwsCluster .
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
The async variant is Google\Cloud\GkeMultiCloud\V1\Client\BaseClient\self::createAwsNodePoolAsync() .
request
Google\Cloud\GkeMultiCloud\V1\CreateAwsNodePoolRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
deleteAwsCluster
Deletes a specific AwsCluster resource.
Fails if the cluster has one or more associated AwsNodePool resources.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
The async variant is Google\Cloud\GkeMultiCloud\V1\Client\BaseClient\self::deleteAwsClusterAsync() .
request
Google\Cloud\GkeMultiCloud\V1\DeleteAwsClusterRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
deleteAwsNodePool
Deletes a specific AwsNodePool resource.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
The async variant is Google\Cloud\GkeMultiCloud\V1\Client\BaseClient\self::deleteAwsNodePoolAsync() .
request
Google\Cloud\GkeMultiCloud\V1\DeleteAwsNodePoolRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
generateAwsAccessToken
Generates a short-lived access token to authenticate to a given AwsCluster resource.
The async variant is Google\Cloud\GkeMultiCloud\V1\Client\BaseClient\self::generateAwsAccessTokenAsync() .
request
Google\Cloud\GkeMultiCloud\V1\GenerateAwsAccessTokenRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getAwsCluster
Describes a specific AwsCluster resource.
The async variant is Google\Cloud\GkeMultiCloud\V1\Client\BaseClient\self::getAwsClusterAsync() .
request
Google\Cloud\GkeMultiCloud\V1\GetAwsClusterRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getAwsNodePool
Describes a specific AwsNodePool resource.
The async variant is Google\Cloud\GkeMultiCloud\V1\Client\BaseClient\self::getAwsNodePoolAsync() .
request
Google\Cloud\GkeMultiCloud\V1\GetAwsNodePoolRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getAwsServerConfig
Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.
The async variant is Google\Cloud\GkeMultiCloud\V1\Client\BaseClient\self::getAwsServerConfigAsync() .
request
Google\Cloud\GkeMultiCloud\V1\GetAwsServerConfigRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
listAwsClusters
Lists all AwsCluster resources on a given Google Cloud project and region.
The async variant is Google\Cloud\GkeMultiCloud\V1\Client\BaseClient\self::listAwsClustersAsync() .
request
Google\Cloud\GkeMultiCloud\V1\ListAwsClustersRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
listAwsNodePools
Lists all AwsNodePool resources on a given AwsCluster .
The async variant is Google\Cloud\GkeMultiCloud\V1\Client\BaseClient\self::listAwsNodePoolsAsync() .
request
Google\Cloud\GkeMultiCloud\V1\ListAwsNodePoolsRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
updateAwsCluster
Updates an AwsCluster .
The async variant is Google\Cloud\GkeMultiCloud\V1\Client\BaseClient\self::updateAwsClusterAsync() .
request
Google\Cloud\GkeMultiCloud\V1\UpdateAwsClusterRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
updateAwsNodePool
Updates an AwsNodePool .
The async variant is Google\Cloud\GkeMultiCloud\V1\Client\BaseClient\self::updateAwsNodePoolAsync() .
request
Google\Cloud\GkeMultiCloud\V1\UpdateAwsNodePoolRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
