InstanceGroupsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.instance_groups.transports.base.InstanceGroupsTransport]] = None, client_options: Optional[Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)The InstanceGroups API.
Properties
transport
Returns the transport used by the client instance.
| Returns | |
|---|---|
| Type | Description |
InstanceGroupsTransport | The transport used by the client instance. |
Methods
InstanceGroupsClient
InstanceGroupsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.instance_groups.transports.base.InstanceGroupsTransport]] = None, client_options: Optional[Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the instance groups client.
| Parameters | |
|---|---|
| Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, InstanceGroupsTransport]
The transport to use. If set to None, a transport is chosen automatically. NOTE: "rest" transport functionality is currently in a beta state (preview). We welcome your feedback via an issue in this library's source repository. |
client_options |
Optional[Union[google.api_core.client_options.ClientOptions, dict]]
Custom options for the client. It won't take effect if a |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)Releases underlying transport's resources.
add_instances
add_instances(request: Optional[Union[google.cloud.compute_v1.types.compute.AddInstancesInstanceGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group: Optional[str] = None, instance_groups_add_instances_request_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupsAddInstancesRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.AddInstancesInstanceGroupRequest, dict]
The request object. A request message for InstanceGroups.AddInstances. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
zone |
str
The name of the zone where the instance group is located. This corresponds to the |
instance_group |
str
The name of the instance group where you are adding instances. This corresponds to the |
instance_groups_add_instances_request_resource |
google.cloud.compute_v1.types.InstanceGroupsAddInstancesRequest
The body resource for this request This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
add_instances_unary
add_instances_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.AddInstancesInstanceGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group: Optional[str] = None, instance_groups_add_instances_request_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupsAddInstancesRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.AddInstancesInstanceGroupRequest, dict]
The request object. A request message for InstanceGroups.AddInstances. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
zone |
str
The name of the zone where the instance group is located. This corresponds to the |
instance_group |
str
The name of the instance group where you are adding instances. This corresponds to the |
instance_groups_add_instances_request_resource |
google.cloud.compute_v1.types.InstanceGroupsAddInstancesRequest
The body resource for this request This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
aggregated_list
aggregated_list(request: Optional[Union[google.cloud.compute_v1.types.compute.AggregatedListInstanceGroupsRequest, dict]] = None, *, project: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Retrieves the list of instance groups and sorts them by zone.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.AggregatedListInstanceGroupsRequest, dict]
The request object. A request message for InstanceGroups.AggregatedList. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.compute_v1.services.instance_groups.pagers.AggregatedListPager | Iterating over this object will yield results and resolve additional pages automatically. |
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
delete
delete(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteInstanceGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.DeleteInstanceGroupRequest, dict]
The request object. A request message for InstanceGroups.Delete. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
zone |
str
The name of the zone where the instance group is located. This corresponds to the |
instance_group |
str
The name of the instance group to delete. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
delete_unary
delete_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteInstanceGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.DeleteInstanceGroupRequest, dict]
The request object. A request message for InstanceGroups.Delete. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
zone |
str
The name of the zone where the instance group is located. This corresponds to the |
instance_group |
str
The name of the instance group to delete. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupsClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Parameter | |
|---|---|
| Name | Description |
info |
dict
The service account private key info. |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupsClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupsClient | The constructed client. |
get
get(request: Optional[Union[google.cloud.compute_v1.types.compute.GetInstanceGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.GetInstanceGroupRequest, dict]
The request object. A request message for InstanceGroups.Get. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
zone |
str
The name of the zone where the instance group is located. This corresponds to the |
instance_group |
str
The name of the instance group. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.compute_v1.types.InstanceGroup | Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups. For more information, read Instance groups. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the
default mTLS endpoint; if the environment variable is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
| Parameter | |
|---|---|
| Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Returns | |
|---|---|
| Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
insert
insert(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertInstanceGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroup] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Creates an instance group in the specified project using the parameters that are included in the request.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.InsertInstanceGroupRequest, dict]
The request object. A request message for InstanceGroups.Insert. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
zone |
str
The name of the zone where you want to create the instance group. This corresponds to the |
instance_group_resource |
google.cloud.compute_v1.types.InstanceGroup
The body resource for this request This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
insert_unary
insert_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertInstanceGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroup] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Creates an instance group in the specified project using the parameters that are included in the request.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.InsertInstanceGroupRequest, dict]
The request object. A request message for InstanceGroups.Insert. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
zone |
str
The name of the zone where you want to create the instance group. This corresponds to the |
instance_group_resource |
google.cloud.compute_v1.types.InstanceGroup
The body resource for this request This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
list
list(request: Optional[Union[google.cloud.compute_v1.types.compute.ListInstanceGroupsRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.ListInstanceGroupsRequest, dict]
The request object. A request message for InstanceGroups.List. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
zone |
str
The name of the zone where the instance group is located. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.compute_v1.services.instance_groups.pagers.ListPager | A list of InstanceGroup resources. Iterating over this object will yield results and resolve additional pages automatically. |
list_instances
list_instances(request: Optional[Union[google.cloud.compute_v1.types.compute.ListInstancesInstanceGroupsRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group: Optional[str] = None, instance_groups_list_instances_request_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupsListInstancesRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Lists the instances in the specified instance group. The orderBy
query parameter is not supported. The filter query parameter is
supported, but only for expressions that use eq (equal) or
ne (not equal) operators.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.ListInstancesInstanceGroupsRequest, dict]
The request object. A request message for InstanceGroups.ListInstances. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
zone |
str
The name of the zone where the instance group is located. This corresponds to the |
instance_group |
str
The name of the instance group from which you want to generate a list of included instances. This corresponds to the |
instance_groups_list_instances_request_resource |
google.cloud.compute_v1.types.InstanceGroupsListInstancesRequest
The body resource for this request This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.compute_v1.services.instance_groups.pagers.ListInstancesPager | Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
remove_instances
remove_instances(request: Optional[Union[google.cloud.compute_v1.types.compute.RemoveInstancesInstanceGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group: Optional[str] = None, instance_groups_remove_instances_request_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupsRemoveInstancesRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.RemoveInstancesInstanceGroupRequest, dict]
The request object. A request message for InstanceGroups.RemoveInstances. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
zone |
str
The name of the zone where the instance group is located. This corresponds to the |
instance_group |
str
The name of the instance group where the specified instances will be removed. This corresponds to the |
instance_groups_remove_instances_request_resource |
google.cloud.compute_v1.types.InstanceGroupsRemoveInstancesRequest
The body resource for this request This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
remove_instances_unary
remove_instances_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.RemoveInstancesInstanceGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group: Optional[str] = None, instance_groups_remove_instances_request_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupsRemoveInstancesRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.RemoveInstancesInstanceGroupRequest, dict]
The request object. A request message for InstanceGroups.RemoveInstances. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
zone |
str
The name of the zone where the instance group is located. This corresponds to the |
instance_group |
str
The name of the instance group where the specified instances will be removed. This corresponds to the |
instance_groups_remove_instances_request_resource |
google.cloud.compute_v1.types.InstanceGroupsRemoveInstancesRequest
The body resource for this request This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
set_named_ports
set_named_ports(request: Optional[Union[google.cloud.compute_v1.types.compute.SetNamedPortsInstanceGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group: Optional[str] = None, instance_groups_set_named_ports_request_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupsSetNamedPortsRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Sets the named ports for the specified instance group.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.SetNamedPortsInstanceGroupRequest, dict]
The request object. A request message for InstanceGroups.SetNamedPorts. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
zone |
str
The name of the zone where the instance group is located. This corresponds to the |
instance_group |
str
The name of the instance group where the named ports are updated. This corresponds to the |
instance_groups_set_named_ports_request_resource |
google.cloud.compute_v1.types.InstanceGroupsSetNamedPortsRequest
The body resource for this request This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
set_named_ports_unary
set_named_ports_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.SetNamedPortsInstanceGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group: Optional[str] = None, instance_groups_set_named_ports_request_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupsSetNamedPortsRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Sets the named ports for the specified instance group.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.SetNamedPortsInstanceGroupRequest, dict]
The request object. A request message for InstanceGroups.SetNamedPorts. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
zone |
str
The name of the zone where the instance group is located. This corresponds to the |
instance_group |
str
The name of the instance group where the named ports are updated. This corresponds to the |
instance_groups_set_named_ports_request_resource |
google.cloud.compute_v1.types.InstanceGroupsSetNamedPortsRequest
The body resource for this request This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |