1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Compute
  7. \
  8. Resource
  9. \
  10. RegionInstanceGroups

RegionInstanceGroups

class RegionInstanceGroups extends Resource (View source)

The "regionInstanceGroups" collection of methods.

Typical usage is:

 $computeService = new Google\Service\Compute(...);
 $regionInstanceGroups = $computeService->regionInstanceGroups;

Methods

InstanceGroup
get(string $project, string $region, string $instanceGroup, array $optParams = [])

Returns the specified instance group resource. (regionInstanceGroups.get)

RegionInstanceGroupList
listRegionInstanceGroups(string $project, string $region, array $optParams = [])

Retrieves the list of instance group resources contained within the specified region. (regionInstanceGroups.listRegionInstanceGroups)

RegionInstanceGroupsListInstances
listInstances(string $project, string $region, string $instanceGroup, RegionInstanceGroupsListInstancesRequest $postBody, array $optParams = [])

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. (regionInstanceGroups.listInstances)

Operation
setNamedPorts(string $project, string $region, string $instanceGroup, RegionInstanceGroupsSetNamedPortsRequest $postBody, array $optParams = [])

Sets the named ports for the specified regional instance group.

Details

at line 47
InstanceGroup get(string $project, string $region, string $instanceGroup, array $optParams = [])

Returns the specified instance group resource. (regionInstanceGroups.get)

Parameters

string $project

Project ID for this request.
string $region

Name of the region scoping this request.
string $instanceGroup

Name of the instance group resource to return.
array $optParams

Optional parameters.

Return Value

InstanceGroup

Exceptions

Exception

at line 117
RegionInstanceGroupList listRegionInstanceGroups(string $project, string $region, array $optParams = [])

Retrieves the list of instance group resources contained within the specified region. (regionInstanceGroups.listRegionInstanceGroups)

Parameters

string $project

Project ID for this request.
string $region

Name of the region scoping this request.
array $optParams

Optional parameters.

Return Value

RegionInstanceGroupList

Exceptions

Exception

at line 192
RegionInstanceGroupsListInstances listInstances(string $project, string $region, string $instanceGroup, RegionInstanceGroupsListInstancesRequest $postBody, array $optParams = [])

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. (regionInstanceGroups.listInstances)

Parameters

string $project

Project ID for this request.
string $region

Name of the region scoping this request.
string $instanceGroup

Name of the regional instance group for which we want to list the instances.
RegionInstanceGroupsListInstancesRequest $postBody
array $optParams

Optional parameters.

Return Value

RegionInstanceGroupsListInstances

Exceptions

Exception

at line 222
Operation setNamedPorts(string $project, string $region, string $instanceGroup, RegionInstanceGroupsSetNamedPortsRequest $postBody, array $optParams = [])

Sets the named ports for the specified regional instance group.

(regionInstanceGroups.setNamedPorts)

Parameters

string $project

Project ID for this request.
string $region

Name of the region scoping this request.
string $instanceGroup

The name of the regional instance group where the named ports are updated.
RegionInstanceGroupsSetNamedPortsRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception