Reference documentation and code samples for the Google Cloud Dataproc V1 Client class NodeGroupControllerClient.
Service Description: The NodeGroupControllerService
provides methods to manage node groups
of Compute Engine managed instances.
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ Dataproc \ V1 \ ClientMethods
__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.
createNodeGroup
Creates a node group in a cluster. The returned Operation.metadata is NodeGroupOperationMetadata .
The async variant is Google\Cloud\Dataproc\V1\Client\BaseClient\self::createNodeGroupAsync() .
request
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.
getNodeGroup
Gets the resource representation for a node group in a cluster.
The async variant is Google\Cloud\Dataproc\V1\Client\BaseClient\self::getNodeGroupAsync() .
request
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.
resizeNodeGroup
Resizes a node group in a cluster. The returned Operation.metadata is NodeGroupOperationMetadata .
The async variant is Google\Cloud\Dataproc\V1\Client\BaseClient\self::resizeNodeGroupAsync() .
request
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.
createNodeGroupAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getNodeGroupAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
resizeNodeGroupAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
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
static::clusterRegionName
Formats a string containing the fully-qualified path to represent a cluster_region resource.
project
string
region
string
cluster
string
string
static::nodeGroupName
Formats a string containing the fully-qualified path to represent a node_group resource.
project
string
region
string
cluster
string
nodeGroup
string
string
static::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
- clusterRegion: projects/{project}/regions/{region}/clusters/{cluster}
- nodeGroup: projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{node_group}
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
