Reference documentation and code samples for the Compute V1 Client class RegionInstanceGroupsClient.
Service Description: The RegionInstanceGroups API.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Namespace
Google \ Cloud \ Compute \ V1 \ ClientMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 |
↳ 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. At the moment, supports only |
↳ 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 = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method 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. |
get
Returns the specified instance group resource.
The async variant is Google\Cloud\Compute\V1\Client\RegionInstanceGroupsClient::getAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Compute\V1\GetRegionInstanceGroupRequest
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. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\InstanceGroup |
|
list
Retrieves the list of instance group resources contained within the specified region.
The async variant is Google\Cloud\Compute\V1\Client\RegionInstanceGroupsClient::listAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Compute\V1\ListRegionInstanceGroupsRequest
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. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
listInstances
Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported.
The async variant is Google\Cloud\Compute\V1\Client\RegionInstanceGroupsClient::listInstancesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Compute\V1\ListInstancesRegionInstanceGroupsRequest
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. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse |
|
setNamedPorts
Sets the named ports for the specified regional instance group.
The async variant is Google\Cloud\Compute\V1\Client\RegionInstanceGroupsClient::setNamedPortsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Compute\V1\SetNamedPortsRegionInstanceGroupRequest
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. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse |
|
getAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Compute\V1\GetRegionInstanceGroupRequest
|
optionalArgs = [] |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface |
|
listAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Compute\V1\ListRegionInstanceGroupsRequest
|
optionalArgs = [] |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface |
|
listInstancesAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Compute\V1\ListInstancesRegionInstanceGroupsRequest
|
optionalArgs = [] |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface |
|
setNamedPortsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Compute\V1\SetNamedPortsRegionInstanceGroupRequest
|
optionalArgs = [] |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface |
|
getOperationsClient
Return an RegionOperationsClient object with the same endpoint as $this.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\RegionOperationsClient |
|
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 | |
|---|---|
| Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse |
|