As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

NodeGroups¶

class google.cloud.compute_v1.services.node_groups.NodeGroupsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.node_groups.transports.base.NodeGroupsTransport, typing.Callable[[...], google.cloud.compute_v1.services.node_groups.transports.base.NodeGroupsTransport]]] = None, client_options: typing.Optional[typing.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>)[source]¶

The NodeGroups API.

Instantiates the node groups client.

Parameters

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 (Optional[Union[str,NodeGroupsTransport,Callable[..., NodeGroupsTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the NodeGroupsTransport constructor. 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.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
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 None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

add_nodes(request: Optional[Union[google.cloud.compute_v1.types.compute.AddNodesNodeGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, node_group: Optional[str] = None, node_groups_add_nodes_request_resource: Optional[google.cloud.compute_v1.types.compute.NodeGroupsAddNodesRequest] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

Adds specified number of nodes to the node group.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_add_nodes():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.AddNodesNodeGroupRequest(
        node_group="node_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.add_nodes(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.AddNodesNodeGroupRequest, dict]) – The request object. A request message for NodeGroups.AddNodes. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
node_group (str) – Name of the NodeGroup resource. This corresponds to the node_group field on the request instance; if request is provided, this should not be set.
node_groups_add_nodes_request_resource (google.cloud.compute_v1.types.NodeGroupsAddNodesRequest) – The body resource for this request This corresponds to the node_groups_add_nodes_request_resource field on the request instance; if request is provided, this should not be set.
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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

add_nodes_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.AddNodesNodeGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, node_group: Optional[str] = None, node_groups_add_nodes_request_resource: Optional[google.cloud.compute_v1.types.compute.NodeGroupsAddNodesRequest] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

Adds specified number of nodes to the node group.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_add_nodes():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.AddNodesNodeGroupRequest(
        node_group="node_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.add_nodes(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.AddNodesNodeGroupRequest, dict]) – The request object. A request message for NodeGroups.AddNodes. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
node_group (str) – Name of the NodeGroup resource. This corresponds to the node_group field on the request instance; if request is provided, this should not be set.
node_groups_add_nodes_request_resource (google.cloud.compute_v1.types.NodeGroupsAddNodesRequest) – The body resource for this request This corresponds to the node_groups_add_nodes_request_resource field on the request instance; if request is provided, this should not be set.
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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

aggregated_list(request: Optional[Union[google.cloud.compute_v1.types.compute.AggregatedListNodeGroupsRequest, dict]] = None, *, project: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.services.node_groups.pagers.AggregatedListPager[source]¶

Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_aggregated_list():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.AggregatedListNodeGroupsRequest(
        project="project_value",
    )

    # Make the request
    page_result = client.aggregated_list(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.compute_v1.types.AggregatedListNodeGroupsRequest, dict]) – The request object. A request message for NodeGroups.AggregatedList. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
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

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.compute_v1.services.node_groups.pagers.AggregatedListPager

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

delete(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteNodeGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, node_group: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

Deletes the specified NodeGroup resource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_delete():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteNodeGroupRequest(
        node_group="node_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.delete(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.DeleteNodeGroupRequest, dict]) – The request object. A request message for NodeGroups.Delete. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
node_group (str) –
Name of the NodeGroup resource to delete.

This corresponds to the node_group field on the request instance; if request is provided, this should not be set.
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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

delete_nodes(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteNodesNodeGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, node_group: Optional[str] = None, node_groups_delete_nodes_request_resource: Optional[google.cloud.compute_v1.types.compute.NodeGroupsDeleteNodesRequest] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

Deletes specified nodes from the node group.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_delete_nodes():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteNodesNodeGroupRequest(
        node_group="node_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.delete_nodes(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.DeleteNodesNodeGroupRequest, dict]) – The request object. A request message for NodeGroups.DeleteNodes. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
node_group (str) –
Name of the NodeGroup resource whose nodes will be deleted.

This corresponds to the node_group field on the request instance; if request is provided, this should not be set.
node_groups_delete_nodes_request_resource (google.cloud.compute_v1.types.NodeGroupsDeleteNodesRequest) – The body resource for this request This corresponds to the node_groups_delete_nodes_request_resource field on the request instance; if request is provided, this should not be set.
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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

delete_nodes_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteNodesNodeGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, node_group: Optional[str] = None, node_groups_delete_nodes_request_resource: Optional[google.cloud.compute_v1.types.compute.NodeGroupsDeleteNodesRequest] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

Deletes specified nodes from the node group.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_delete_nodes():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteNodesNodeGroupRequest(
        node_group="node_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.delete_nodes(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.DeleteNodesNodeGroupRequest, dict]) – The request object. A request message for NodeGroups.DeleteNodes. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
node_group (str) –
Name of the NodeGroup resource whose nodes will be deleted.

This corresponds to the node_group field on the request instance; if request is provided, this should not be set.
node_groups_delete_nodes_request_resource (google.cloud.compute_v1.types.NodeGroupsDeleteNodesRequest) – The body resource for this request This corresponds to the node_groups_delete_nodes_request_resource field on the request instance; if request is provided, this should not be set.
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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

delete_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteNodeGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, node_group: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

Deletes the specified NodeGroup resource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_delete():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteNodeGroupRequest(
        node_group="node_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.delete(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.DeleteNodeGroupRequest, dict]) – The request object. A request message for NodeGroups.Delete. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
node_group (str) –
Name of the NodeGroup resource to delete.

This corresponds to the node_group field on the request instance; if request is provided, this should not be set.
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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

NodeGroupsClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

NodeGroupsClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

NodeGroupsClient

get(request: Optional[Union[google.cloud.compute_v1.types.compute.GetNodeGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, node_group: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.NodeGroup[source]¶

Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the “nodes” field should not be used. Use nodeGroups.listNodes instead.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_get():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.GetNodeGroupRequest(
        node_group="node_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.get(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.GetNodeGroupRequest, dict]) – The request object. A request message for NodeGroups.Get. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
node_group (str) – Name of the node group to return. This corresponds to the node_group field on the request instance; if request is provided, this should not be set.
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

Represents a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes.

Return type

google.cloud.compute_v1.types.NodeGroup

get_iam_policy(request: Optional[Union[google.cloud.compute_v1.types.compute.GetIamPolicyNodeGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, resource: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Policy[source]¶

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_get_iam_policy():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.GetIamPolicyNodeGroupRequest(
        project="project_value",
        resource="resource_value",
        zone="zone_value",
    )

    # Make the request
    response = client.get_iam_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.GetIamPolicyNodeGroupRequest, dict]) – The request object. A request message for NodeGroups.GetIamPolicy. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
resource (str) –
Name or id of the resource for this request.

This corresponds to the resource field on the request instance; if request is provided, this should not be set.
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

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). JSON example: ` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }` YAML example: ` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Return type

google.cloud.compute_v1.types.Policy

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Deprecated. 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.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

insert(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertNodeGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, initial_node_count: Optional[int] = None, node_group_resource: Optional[google.cloud.compute_v1.types.compute.NodeGroup] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

Creates a NodeGroup resource in the specified project using the data included in the request.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_insert():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.InsertNodeGroupRequest(
        initial_node_count=1911,
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.insert(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.InsertNodeGroupRequest, dict]) – The request object. A request message for NodeGroups.Insert. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
initial_node_count (int) –
Initial count of nodes in the node group.

This corresponds to the initial_node_count field on the request instance; if request is provided, this should not be set.
node_group_resource (google.cloud.compute_v1.types.NodeGroup) – The body resource for this request This corresponds to the node_group_resource field on the request instance; if request is provided, this should not be set.
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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

insert_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertNodeGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, initial_node_count: Optional[int] = None, node_group_resource: Optional[google.cloud.compute_v1.types.compute.NodeGroup] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

Creates a NodeGroup resource in the specified project using the data included in the request.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_insert():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.InsertNodeGroupRequest(
        initial_node_count=1911,
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.insert(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.InsertNodeGroupRequest, dict]) – The request object. A request message for NodeGroups.Insert. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
initial_node_count (int) –
Initial count of nodes in the node group.

This corresponds to the initial_node_count field on the request instance; if request is provided, this should not be set.
node_group_resource (google.cloud.compute_v1.types.NodeGroup) – The body resource for this request This corresponds to the node_group_resource field on the request instance; if request is provided, this should not be set.
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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

list(request: Optional[Union[google.cloud.compute_v1.types.compute.ListNodeGroupsRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.services.node_groups.pagers.ListPager[source]¶

Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_list():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.ListNodeGroupsRequest(
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    page_result = client.list(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.compute_v1.types.ListNodeGroupsRequest, dict]) – The request object. A request message for NodeGroups.List. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
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

Contains a list of nodeGroups.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.compute_v1.services.node_groups.pagers.ListPager

list_nodes(request: Optional[Union[google.cloud.compute_v1.types.compute.ListNodesNodeGroupsRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, node_group: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.services.node_groups.pagers.ListNodesPager[source]¶

Lists nodes in the node group.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_list_nodes():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.ListNodesNodeGroupsRequest(
        node_group="node_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    page_result = client.list_nodes(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.compute_v1.types.ListNodesNodeGroupsRequest, dict]) – The request object. A request message for NodeGroups.ListNodes. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
node_group (str) –
Name of the NodeGroup resource whose nodes you want to list.

This corresponds to the node_group field on the request instance; if request is provided, this should not be set.
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

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.compute_v1.services.node_groups.pagers.ListNodesPager

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

patch(request: Optional[Union[google.cloud.compute_v1.types.compute.PatchNodeGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, node_group: Optional[str] = None, node_group_resource: Optional[google.cloud.compute_v1.types.compute.NodeGroup] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

Updates the specified node group.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_patch():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.PatchNodeGroupRequest(
        node_group="node_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.patch(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.PatchNodeGroupRequest, dict]) – The request object. A request message for NodeGroups.Patch. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
node_group (str) –
Name of the NodeGroup resource to update.

This corresponds to the node_group field on the request instance; if request is provided, this should not be set.
node_group_resource (google.cloud.compute_v1.types.NodeGroup) – The body resource for this request This corresponds to the node_group_resource field on the request instance; if request is provided, this should not be set.
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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

patch_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.PatchNodeGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, node_group: Optional[str] = None, node_group_resource: Optional[google.cloud.compute_v1.types.compute.NodeGroup] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

Updates the specified node group.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_patch():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.PatchNodeGroupRequest(
        node_group="node_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.patch(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.PatchNodeGroupRequest, dict]) – The request object. A request message for NodeGroups.Patch. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
node_group (str) –
Name of the NodeGroup resource to update.

This corresponds to the node_group field on the request instance; if request is provided, this should not be set.
node_group_resource (google.cloud.compute_v1.types.NodeGroup) – The body resource for this request This corresponds to the node_group_resource field on the request instance; if request is provided, this should not be set.
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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

perform_maintenance(request: Optional[Union[google.cloud.compute_v1.types.compute.PerformMaintenanceNodeGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, node_group: Optional[str] = None, node_groups_perform_maintenance_request_resource: Optional[google.cloud.compute_v1.types.compute.NodeGroupsPerformMaintenanceRequest] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

Perform maintenance on a subset of nodes in the node group.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_perform_maintenance():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.PerformMaintenanceNodeGroupRequest(
        node_group="node_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.perform_maintenance(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.PerformMaintenanceNodeGroupRequest, dict]) – The request object. A request message for NodeGroups.PerformMaintenance. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
node_group (str) –
Name of the node group scoping this request.

This corresponds to the node_group field on the request instance; if request is provided, this should not be set.
node_groups_perform_maintenance_request_resource (google.cloud.compute_v1.types.NodeGroupsPerformMaintenanceRequest) – The body resource for this request This corresponds to the node_groups_perform_maintenance_request_resource field on the request instance; if request is provided, this should not be set.
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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

perform_maintenance_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.PerformMaintenanceNodeGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, node_group: Optional[str] = None, node_groups_perform_maintenance_request_resource: Optional[google.cloud.compute_v1.types.compute.NodeGroupsPerformMaintenanceRequest] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

Perform maintenance on a subset of nodes in the node group.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_perform_maintenance():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.PerformMaintenanceNodeGroupRequest(
        node_group="node_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.perform_maintenance(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.PerformMaintenanceNodeGroupRequest, dict]) – The request object. A request message for NodeGroups.PerformMaintenance. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
node_group (str) –
Name of the node group scoping this request.

This corresponds to the node_group field on the request instance; if request is provided, this should not be set.
node_groups_perform_maintenance_request_resource (google.cloud.compute_v1.types.NodeGroupsPerformMaintenanceRequest) – The body resource for this request This corresponds to the node_groups_perform_maintenance_request_resource field on the request instance; if request is provided, this should not be set.
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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

set_iam_policy(request: Optional[Union[google.cloud.compute_v1.types.compute.SetIamPolicyNodeGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, resource: Optional[str] = None, zone_set_policy_request_resource: Optional[google.cloud.compute_v1.types.compute.ZoneSetPolicyRequest] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Policy[source]¶

Sets the access control policy on the specified resource. Replaces any existing policy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_set_iam_policy():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.SetIamPolicyNodeGroupRequest(
        project="project_value",
        resource="resource_value",
        zone="zone_value",
    )

    # Make the request
    response = client.set_iam_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.SetIamPolicyNodeGroupRequest, dict]) – The request object. A request message for NodeGroups.SetIamPolicy. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
resource (str) –
Name or id of the resource for this request.

This corresponds to the resource field on the request instance; if request is provided, this should not be set.
zone_set_policy_request_resource (google.cloud.compute_v1.types.ZoneSetPolicyRequest) – The body resource for this request This corresponds to the zone_set_policy_request_resource field on the request instance; if request is provided, this should not be set.
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

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). JSON example: ` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }` YAML example: ` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Return type

google.cloud.compute_v1.types.Policy

set_node_template(request: Optional[Union[google.cloud.compute_v1.types.compute.SetNodeTemplateNodeGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, node_group: Optional[str] = None, node_groups_set_node_template_request_resource: Optional[google.cloud.compute_v1.types.compute.NodeGroupsSetNodeTemplateRequest] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

Updates the node template of the node group.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_set_node_template():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.SetNodeTemplateNodeGroupRequest(
        node_group="node_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.set_node_template(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.SetNodeTemplateNodeGroupRequest, dict]) – The request object. A request message for NodeGroups.SetNodeTemplate. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
node_group (str) –
Name of the NodeGroup resource to update.

This corresponds to the node_group field on the request instance; if request is provided, this should not be set.
node_groups_set_node_template_request_resource (google.cloud.compute_v1.types.NodeGroupsSetNodeTemplateRequest) – The body resource for this request This corresponds to the node_groups_set_node_template_request_resource field on the request instance; if request is provided, this should not be set.
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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

set_node_template_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.SetNodeTemplateNodeGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, node_group: Optional[str] = None, node_groups_set_node_template_request_resource: Optional[google.cloud.compute_v1.types.compute.NodeGroupsSetNodeTemplateRequest] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

Updates the node template of the node group.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_set_node_template():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.SetNodeTemplateNodeGroupRequest(
        node_group="node_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.set_node_template(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.SetNodeTemplateNodeGroupRequest, dict]) – The request object. A request message for NodeGroups.SetNodeTemplate. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
node_group (str) –
Name of the NodeGroup resource to update.

This corresponds to the node_group field on the request instance; if request is provided, this should not be set.
node_groups_set_node_template_request_resource (google.cloud.compute_v1.types.NodeGroupsSetNodeTemplateRequest) – The body resource for this request This corresponds to the node_groups_set_node_template_request_resource field on the request instance; if request is provided, this should not be set.
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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

simulate_maintenance_event(request: Optional[Union[google.cloud.compute_v1.types.compute.SimulateMaintenanceEventNodeGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, node_group: Optional[str] = None, node_groups_simulate_maintenance_event_request_resource: Optional[google.cloud.compute_v1.types.compute.NodeGroupsSimulateMaintenanceEventRequest] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

Simulates maintenance event on specified nodes from the node group.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_simulate_maintenance_event():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.SimulateMaintenanceEventNodeGroupRequest(
        node_group="node_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.simulate_maintenance_event(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.SimulateMaintenanceEventNodeGroupRequest, dict]) – The request object. A request message for NodeGroups.SimulateMaintenanceEvent. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
node_group (str) –
Name of the NodeGroup resource whose nodes will go under maintenance simulation.

This corresponds to the node_group field on the request instance; if request is provided, this should not be set.
node_groups_simulate_maintenance_event_request_resource (google.cloud.compute_v1.types.NodeGroupsSimulateMaintenanceEventRequest) – The body resource for this request This corresponds to the node_groups_simulate_maintenance_event_request_resource field on the request instance; if request is provided, this should not be set.
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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

simulate_maintenance_event_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.SimulateMaintenanceEventNodeGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, node_group: Optional[str] = None, node_groups_simulate_maintenance_event_request_resource: Optional[google.cloud.compute_v1.types.compute.NodeGroupsSimulateMaintenanceEventRequest] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

Simulates maintenance event on specified nodes from the node group.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_simulate_maintenance_event():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.SimulateMaintenanceEventNodeGroupRequest(
        node_group="node_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.simulate_maintenance_event(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.SimulateMaintenanceEventNodeGroupRequest, dict]) – The request object. A request message for NodeGroups.SimulateMaintenanceEvent. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
node_group (str) –
Name of the NodeGroup resource whose nodes will go under maintenance simulation.

This corresponds to the node_group field on the request instance; if request is provided, this should not be set.
node_groups_simulate_maintenance_event_request_resource (google.cloud.compute_v1.types.NodeGroupsSimulateMaintenanceEventRequest) – The body resource for this request This corresponds to the node_groups_simulate_maintenance_event_request_resource field on the request instance; if request is provided, this should not be set.
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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

test_iam_permissions(request: Optional[Union[google.cloud.compute_v1.types.compute.TestIamPermissionsNodeGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, resource: Optional[str] = None, test_permissions_request_resource: Optional[google.cloud.compute_v1.types.compute.TestPermissionsRequest] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.TestPermissionsResponse[source]¶

Returns permissions that a caller has on the specified resource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_test_iam_permissions():
    # Create a client
    client = compute_v1.NodeGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.TestIamPermissionsNodeGroupRequest(
        project="project_value",
        resource="resource_value",
        zone="zone_value",
    )

    # Make the request
    response = client.test_iam_permissions(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.TestIamPermissionsNodeGroupRequest, dict]) – The request object. A request message for NodeGroups.TestIamPermissions. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
resource (str) –
Name or id of the resource for this request.

This corresponds to the resource field on the request instance; if request is provided, this should not be set.
test_permissions_request_resource (google.cloud.compute_v1.types.TestPermissionsRequest) – The body resource for this request This corresponds to the test_permissions_request_resource field on the request instance; if request is provided, this should not be set.
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.

Return type

google.cloud.compute_v1.types.TestPermissionsResponse

property transport: google.cloud.compute_v1.services.node_groups.transports.base.NodeGroupsTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

NodeGroupsTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

class google.cloud.compute_v1.services.node_groups.pagers.AggregatedListPager(method: Callable[[...], google.cloud.compute_v1.types.compute.NodeGroupAggregatedList], request: google.cloud.compute_v1.types.compute.AggregatedListNodeGroupsRequest, response: google.cloud.compute_v1.types.compute.NodeGroupAggregatedList, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through aggregated_list requests.

This class thinly wraps an initial google.cloud.compute_v1.types.NodeGroupAggregatedList object, and provides an __iter__ method to iterate through its items field.

If there are more pages, the __iter__ method will make additional AggregatedList requests and continue to iterate through the items field on the corresponding responses.

All the usual google.cloud.compute_v1.types.NodeGroupAggregatedList attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.compute_v1.types.AggregatedListNodeGroupsRequest) – The initial request object.
response (google.cloud.compute_v1.types.NodeGroupAggregatedList) – The initial response object.
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.

class google.cloud.compute_v1.services.node_groups.pagers.ListNodesPager(method: Callable[[...], google.cloud.compute_v1.types.compute.NodeGroupsListNodes], request: google.cloud.compute_v1.types.compute.ListNodesNodeGroupsRequest, response: google.cloud.compute_v1.types.compute.NodeGroupsListNodes, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_nodes requests.

This class thinly wraps an initial google.cloud.compute_v1.types.NodeGroupsListNodes object, and provides an __iter__ method to iterate through its items field.

If there are more pages, the __iter__ method will make additional ListNodes requests and continue to iterate through the items field on the corresponding responses.

All the usual google.cloud.compute_v1.types.NodeGroupsListNodes attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.compute_v1.types.ListNodesNodeGroupsRequest) – The initial request object.
response (google.cloud.compute_v1.types.NodeGroupsListNodes) – The initial response object.
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.

class google.cloud.compute_v1.services.node_groups.pagers.ListPager(method: Callable[[...], google.cloud.compute_v1.types.compute.NodeGroupList], request: google.cloud.compute_v1.types.compute.ListNodeGroupsRequest, response: google.cloud.compute_v1.types.compute.NodeGroupList, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list requests.

This class thinly wraps an initial google.cloud.compute_v1.types.NodeGroupList object, and provides an __iter__ method to iterate through its items field.

If there are more pages, the __iter__ method will make additional List requests and continue to iterate through the items field on the corresponding responses.

All the usual google.cloud.compute_v1.types.NodeGroupList attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.compute_v1.types.ListNodeGroupsRequest) – The initial request object.
response (google.cloud.compute_v1.types.NodeGroupList) – The initial response object.
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.

NodeGroups¶

google-cloud-compute

Navigation

Related Topics