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]] = 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>)
The NodeGroups API.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
NodeGroupsTransport | The transport used by the client instance. |
Methods
NodeGroupsClient
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]] = 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>)
Instantiates the node 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, NodeGroupsTransport]
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_nodes
add_nodes(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.AddNodesNodeGroupRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
zone: typing.Optional[str] = None,
node_group: typing.Optional[str] = None,
node_groups_add_nodes_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.NodeGroupsAddNodesRequest
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Adds specified number of nodes to the node group.
Parameters | |
---|---|
Name | Description |
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 |
zone |
str
The name of the zone for this request. This corresponds to the |
node_group |
str
Name of the NodeGroup resource. This corresponds to the |
node_groups_add_nodes_request_resource |
google.cloud.compute_v1.types.NodeGroupsAddNodesRequest
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_nodes_unary
add_nodes_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.AddNodesNodeGroupRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
zone: typing.Optional[str] = None,
node_group: typing.Optional[str] = None,
node_groups_add_nodes_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.NodeGroupsAddNodesRequest
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Adds specified number of nodes to the node group.
Parameters | |
---|---|
Name | Description |
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 |
zone |
str
The name of the zone for this request. This corresponds to the |
node_group |
str
Name of the NodeGroup resource. This corresponds to the |
node_groups_add_nodes_request_resource |
google.cloud.compute_v1.types.NodeGroupsAddNodesRequest
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: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.AggregatedListNodeGroupsRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.services.node_groups.pagers.AggregatedListPager
Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group.
Parameters | |
---|---|
Name | Description |
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 |
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.node_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) -> str
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
delete
delete(
request: typing.Optional[
typing.Union[google.cloud.compute_v1.types.compute.DeleteNodeGroupRequest, dict]
] = None,
*,
project: typing.Optional[str] = None,
zone: typing.Optional[str] = None,
node_group: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Deletes the specified NodeGroup resource.
Parameters | |
---|---|
Name | Description |
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 |
zone |
str
The name of the zone for this request. This corresponds to the |
node_group |
str
Name of the NodeGroup resource 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_nodes
delete_nodes(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.DeleteNodesNodeGroupRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
zone: typing.Optional[str] = None,
node_group: typing.Optional[str] = None,
node_groups_delete_nodes_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.NodeGroupsDeleteNodesRequest
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Deletes specified nodes from the node group.
Parameters | |
---|---|
Name | Description |
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 |
zone |
str
The name of the zone for this request. This corresponds to the |
node_group |
str
Name of the NodeGroup resource whose nodes will be deleted. This corresponds to the |
node_groups_delete_nodes_request_resource |
google.cloud.compute_v1.types.NodeGroupsDeleteNodesRequest
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. |
delete_nodes_unary
delete_nodes_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.DeleteNodesNodeGroupRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
zone: typing.Optional[str] = None,
node_group: typing.Optional[str] = None,
node_groups_delete_nodes_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.NodeGroupsDeleteNodesRequest
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Deletes specified nodes from the node group.
Parameters | |
---|---|
Name | Description |
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 |
zone |
str
The name of the zone for this request. This corresponds to the |
node_group |
str
Name of the NodeGroup resource whose nodes will be deleted. This corresponds to the |
node_groups_delete_nodes_request_resource |
google.cloud.compute_v1.types.NodeGroupsDeleteNodesRequest
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. |
delete_unary
delete_unary(
request: typing.Optional[
typing.Union[google.cloud.compute_v1.types.compute.DeleteNodeGroupRequest, dict]
] = None,
*,
project: typing.Optional[str] = None,
zone: typing.Optional[str] = None,
node_group: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Deletes the specified NodeGroup resource.
Parameters | |
---|---|
Name | Description |
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 |
zone |
str
The name of the zone for this request. This corresponds to the |
node_group |
str
Name of the NodeGroup resource 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 |
NodeGroupsClient | 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 |
NodeGroupsClient | 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 |
NodeGroupsClient | The constructed client. |
get
get(
request: typing.Optional[
typing.Union[google.cloud.compute_v1.types.compute.GetNodeGroupRequest, dict]
] = None,
*,
project: typing.Optional[str] = None,
zone: typing.Optional[str] = None,
node_group: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.NodeGroup
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.
Parameters | |
---|---|
Name | Description |
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 |
zone |
str
The name of the zone for this request. This corresponds to the |
node_group |
str
Name of the node group to return. 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.NodeGroup | 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. |
get_iam_policy
get_iam_policy(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.GetIamPolicyNodeGroupRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
zone: typing.Optional[str] = None,
resource: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Policy
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameters | |
---|---|
Name | Description |
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 |
zone |
str
The name of the zone for this request. This corresponds to the |
resource |
str
Name or id of the 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.types.Policy | 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](\=""> |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.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: typing.Optional[
typing.Union[google.cloud.compute_v1.types.compute.InsertNodeGroupRequest, dict]
] = None,
*,
project: typing.Optional[str] = None,
zone: typing.Optional[str] = None,
initial_node_count: typing.Optional[int] = None,
node_group_resource: typing.Optional[
google.cloud.compute_v1.types.compute.NodeGroup
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Creates a NodeGroup resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
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 |
zone |
str
The name of the zone for this request. This corresponds to the |
initial_node_count |
int
Initial count of nodes in the node group. This corresponds to the |
node_group_resource |
google.cloud.compute_v1.types.NodeGroup
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: typing.Optional[
typing.Union[google.cloud.compute_v1.types.compute.InsertNodeGroupRequest, dict]
] = None,
*,
project: typing.Optional[str] = None,
zone: typing.Optional[str] = None,
initial_node_count: typing.Optional[int] = None,
node_group_resource: typing.Optional[
google.cloud.compute_v1.types.compute.NodeGroup
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Creates a NodeGroup resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
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 |
zone |
str
The name of the zone for this request. This corresponds to the |
initial_node_count |
int
Initial count of nodes in the node group. This corresponds to the |
node_group_resource |
google.cloud.compute_v1.types.NodeGroup
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: typing.Optional[
typing.Union[google.cloud.compute_v1.types.compute.ListNodeGroupsRequest, dict]
] = None,
*,
project: typing.Optional[str] = None,
zone: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.services.node_groups.pagers.ListPager
Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.
Parameters | |
---|---|
Name | Description |
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 |
zone |
str
The name of the zone 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.node_groups.pagers.ListPager | Contains a list of nodeGroups. Iterating over this object will yield results and resolve additional pages automatically. |
list_nodes
list_nodes(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.ListNodesNodeGroupsRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
zone: typing.Optional[str] = None,
node_group: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.services.node_groups.pagers.ListNodesPager
Lists nodes in the node group.
Parameters | |
---|---|
Name | Description |
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 |
zone |
str
The name of the zone for this request. This corresponds to the |
node_group |
str
Name of the NodeGroup resource whose nodes you want to list. 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.node_groups.pagers.ListNodesPager | Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
patch
patch(
request: typing.Optional[
typing.Union[google.cloud.compute_v1.types.compute.PatchNodeGroupRequest, dict]
] = None,
*,
project: typing.Optional[str] = None,
zone: typing.Optional[str] = None,
node_group: typing.Optional[str] = None,
node_group_resource: typing.Optional[
google.cloud.compute_v1.types.compute.NodeGroup
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Updates the specified node group.
Parameters | |
---|---|
Name | Description |
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 |
zone |
str
The name of the zone for this request. This corresponds to the |
node_group |
str
Name of the NodeGroup resource to update. This corresponds to the |
node_group_resource |
google.cloud.compute_v1.types.NodeGroup
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. |
patch_unary
patch_unary(
request: typing.Optional[
typing.Union[google.cloud.compute_v1.types.compute.PatchNodeGroupRequest, dict]
] = None,
*,
project: typing.Optional[str] = None,
zone: typing.Optional[str] = None,
node_group: typing.Optional[str] = None,
node_group_resource: typing.Optional[
google.cloud.compute_v1.types.compute.NodeGroup
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Updates the specified node group.
Parameters | |
---|---|
Name | Description |
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 |
zone |
str
The name of the zone for this request. This corresponds to the |
node_group |
str
Name of the NodeGroup resource to update. This corresponds to the |
node_group_resource |
google.cloud.compute_v1.types.NodeGroup
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_iam_policy
set_iam_policy(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SetIamPolicyNodeGroupRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
zone: typing.Optional[str] = None,
resource: typing.Optional[str] = None,
zone_set_policy_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.ZoneSetPolicyRequest
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Policy
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters | |
---|---|
Name | Description |
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 |
zone |
str
The name of the zone for this request. This corresponds to the |
resource |
str
Name or id of the resource for this request. This corresponds to the |
zone_set_policy_request_resource |
google.cloud.compute_v1.types.ZoneSetPolicyRequest
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.types.Policy | 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](\=""> |
set_node_template
set_node_template(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SetNodeTemplateNodeGroupRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
zone: typing.Optional[str] = None,
node_group: typing.Optional[str] = None,
node_groups_set_node_template_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.NodeGroupsSetNodeTemplateRequest
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Updates the node template of the node group.
Parameters | |
---|---|
Name | Description |
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 |
zone |
str
The name of the zone for this request. This corresponds to the |
node_group |
str
Name of the NodeGroup resource to update. This corresponds to the |
node_groups_set_node_template_request_resource |
google.cloud.compute_v1.types.NodeGroupsSetNodeTemplateRequest
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_node_template_unary
set_node_template_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SetNodeTemplateNodeGroupRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
zone: typing.Optional[str] = None,
node_group: typing.Optional[str] = None,
node_groups_set_node_template_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.NodeGroupsSetNodeTemplateRequest
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Updates the node template of the node group.
Parameters | |
---|---|
Name | Description |
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 |
zone |
str
The name of the zone for this request. This corresponds to the |
node_group |
str
Name of the NodeGroup resource to update. This corresponds to the |
node_groups_set_node_template_request_resource |
google.cloud.compute_v1.types.NodeGroupsSetNodeTemplateRequest
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. |
simulate_maintenance_event
simulate_maintenance_event(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SimulateMaintenanceEventNodeGroupRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
zone: typing.Optional[str] = None,
node_group: typing.Optional[str] = None,
node_groups_simulate_maintenance_event_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.NodeGroupsSimulateMaintenanceEventRequest
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Simulates maintenance event on specified nodes from the node group.
Parameters | |
---|---|
Name | Description |
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 |
zone |
str
The name of the zone for this request. This corresponds to the |
node_group |
str
Name of the NodeGroup resource whose nodes will go under maintenance simulation. This corresponds to the |
node_groups_simulate_maintenance_event_request_resource |
google.cloud.compute_v1.types.NodeGroupsSimulateMaintenanceEventRequest
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. |
simulate_maintenance_event_unary
simulate_maintenance_event_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SimulateMaintenanceEventNodeGroupRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
zone: typing.Optional[str] = None,
node_group: typing.Optional[str] = None,
node_groups_simulate_maintenance_event_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.NodeGroupsSimulateMaintenanceEventRequest
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Simulates maintenance event on specified nodes from the node group.
Parameters | |
---|---|
Name | Description |
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 |
zone |
str
The name of the zone for this request. This corresponds to the |
node_group |
str
Name of the NodeGroup resource whose nodes will go under maintenance simulation. This corresponds to the |
node_groups_simulate_maintenance_event_request_resource |
google.cloud.compute_v1.types.NodeGroupsSimulateMaintenanceEventRequest
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. |
test_iam_permissions
test_iam_permissions(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.TestIamPermissionsNodeGroupRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
zone: typing.Optional[str] = None,
resource: typing.Optional[str] = None,
test_permissions_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.TestPermissionsRequest
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.TestPermissionsResponse
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
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 |
zone |
str
The name of the zone for this request. This corresponds to the |
resource |
str
Name or id of the resource for this request. This corresponds to the |
test_permissions_request_resource |
google.cloud.compute_v1.types.TestPermissionsRequest
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. |