Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::NodeGroups::Rest::Client.
REST client for the NodeGroups service.
The NodeGroups API.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the NodeGroups Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all NodeGroups clients ::Google::Cloud::Compute::V1::NodeGroups::Rest::Client.configure do |config| config.timeout = 10.0 end
#add_nodes
def add_nodes(request, options = nil) -> ::Gapic::GenericLRO::Operation
def add_nodes(node_group: nil, node_groups_add_nodes_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Adds specified number of nodes to the node group.
def add_nodes(request, options = nil) -> ::Gapic::GenericLRO::Operation
add_nodes
via a request object, either of type
AddNodesNodeGroupRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::AddNodesNodeGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def add_nodes(node_group: nil, node_groups_add_nodes_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
add_nodes
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- node_group (::String) — Name of the NodeGroup resource.
- node_groups_add_nodes_request_resource (::Google::Cloud::Compute::V1::NodeGroupsAddNodesRequest, ::Hash) — The body resource for this request
- project (::String) — Project ID for this request.
- request_id (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- zone (::String) — The name of the zone for this request.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::GenericLRO::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/compute/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Compute::V1::NodeGroups::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Compute::V1::AddNodesNodeGroupRequest.new # Call the add_nodes method. result = client.add_nodes request # The returned object is of type Google::Cloud::Compute::V1::Operation. p result
#aggregated_list
def aggregated_list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::NodeGroupsScopedList>
def aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil, service_project_number: nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::NodeGroupsScopedList>
Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group.
def aggregated_list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::NodeGroupsScopedList>
aggregated_list
via a request object, either of type
AggregatedListNodeGroupsRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::AggregatedListNodeGroupsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil, service_project_number: nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::NodeGroupsScopedList>
aggregated_list
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
filter (::String) — A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either
=
,!=
,>
,<
,<=
,>=
or:
. For example, if you are filtering Compute Engine instances, you can exclude instances namedexample-instance
by specifyingname != example-instance
. The:*
comparison can be used to test whether a key has been defined. For example, to find all objects withowner
label use:labels.owner:*
You can also filter nested fields. For example, you could specifyscheduling.automaticRestart = false
to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example:(scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake")
By default, each expression is anAND
expression. However, you can includeAND
andOR
expressions explicitly. For example:(cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)
If you want to use a regular expression, use theeq
(equal) orne
(not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:fieldname eq unquoted literal
fieldname eq 'single quoted literal'
fieldname eq "double quoted literal"
(fieldname1 eq literal) (fieldname2 ne "literal")
The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would usename ne .*instance
. You cannot combine constraints on multiple fields using regular expressions. - include_all_scopes (::Boolean) — Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
-
max_results (::Integer) — The maximum number of results per page that should be returned. If the number of available results is larger than
maxResults
, Compute Engine returns anextPageToken
that can be used to get the next page of results in subsequent list requests. Acceptable values are0
to500
, inclusive. (Default:500
) -
order_by (::String) — Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using
orderBy="creationTimestamp desc"
. This sorts results based on thecreationTimestamp
field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting byname
orcreationTimestamp desc
is supported. -
page_token (::String) — Specifies a page token to use. Set
pageToken
to thenextPageToken
returned by a previous list request to get the next page of results. - project (::String) — Project ID for this request.
- return_partial_success (::Boolean) — Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
- service_project_number (::Integer) — The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::NodeGroupsScopedList>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::NodeGroupsScopedList>)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/compute/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Compute::V1::NodeGroups::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Compute::V1::AggregatedListNodeGroupsRequest.new # Call the aggregated_list method. result = client.aggregated_list request # The returned object is of type Google::Cloud::Compute::V1::NodeGroupAggregatedList. p result
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the NodeGroups Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#delete
def delete(request, options = nil) -> ::Gapic::GenericLRO::Operation
def delete(node_group: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Deletes the specified NodeGroup resource.
def delete(request, options = nil) -> ::Gapic::GenericLRO::Operation
delete
via a request object, either of type
DeleteNodeGroupRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::DeleteNodeGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def delete(node_group: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
delete
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- node_group (::String) — Name of the NodeGroup resource to delete.
- project (::String) — Project ID for this request.
- request_id (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- zone (::String) — The name of the zone for this request.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::GenericLRO::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/compute/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Compute::V1::NodeGroups::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Compute::V1::DeleteNodeGroupRequest.new # Call the delete method. result = client.delete request # The returned object is of type Google::Cloud::Compute::V1::Operation. p result
#delete_nodes
def delete_nodes(request, options = nil) -> ::Gapic::GenericLRO::Operation
def delete_nodes(node_group: nil, node_groups_delete_nodes_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Deletes specified nodes from the node group.
def delete_nodes(request, options = nil) -> ::Gapic::GenericLRO::Operation
delete_nodes
via a request object, either of type
DeleteNodesNodeGroupRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::DeleteNodesNodeGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def delete_nodes(node_group: nil, node_groups_delete_nodes_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
delete_nodes
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- node_group (::String) — Name of the NodeGroup resource whose nodes will be deleted.
- node_groups_delete_nodes_request_resource (::Google::Cloud::Compute::V1::NodeGroupsDeleteNodesRequest, ::Hash) — The body resource for this request
- project (::String) — Project ID for this request.
- request_id (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- zone (::String) — The name of the zone for this request.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::GenericLRO::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/compute/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Compute::V1::NodeGroups::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Compute::V1::DeleteNodesNodeGroupRequest.new # Call the delete_nodes method. result = client.delete_nodes request # The returned object is of type Google::Cloud::Compute::V1::Operation. p result
#get
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::NodeGroup
def get(node_group: nil, project: nil, zone: nil) -> ::Google::Cloud::Compute::V1::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.
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::NodeGroup
get
via a request object, either of type
GetNodeGroupRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::GetNodeGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get(node_group: nil, project: nil, zone: nil) -> ::Google::Cloud::Compute::V1::NodeGroup
get
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- node_group (::String) — Name of the node group to return.
- project (::String) — Project ID for this request.
- zone (::String) — The name of the zone for this request.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Compute::V1::NodeGroup)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/compute/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Compute::V1::NodeGroups::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Compute::V1::GetNodeGroupRequest.new # Call the get method. result = client.get request # The returned object is of type Google::Cloud::Compute::V1::NodeGroup. p result
#get_iam_policy
def get_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
def get_iam_policy(options_requested_policy_version: nil, project: nil, resource: nil, zone: nil) -> ::Google::Cloud::Compute::V1::Policy
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
def get_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
get_iam_policy
via a request object, either of type
GetIamPolicyNodeGroupRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::GetIamPolicyNodeGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get_iam_policy(options_requested_policy_version: nil, project: nil, resource: nil, zone: nil) -> ::Google::Cloud::Compute::V1::Policy
get_iam_policy
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- options_requested_policy_version (::Integer) — Requested IAM Policy version.
- project (::String) — Project ID for this request.
- resource (::String) — Name or id of the resource for this request.
- zone (::String) — The name of the zone for this request.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Compute::V1::Policy)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/compute/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Compute::V1::NodeGroups::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Compute::V1::GetIamPolicyNodeGroupRequest.new # Call the get_iam_policy method. result = client.get_iam_policy request # The returned object is of type Google::Cloud::Compute::V1::Policy. p result
#initialize
def initialize() { |config| ... } -> Client
Create a new NodeGroups REST client object.
- (config) — Configure the NodeGroups client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::Compute::V1::NodeGroups::Rest::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Compute::V1::NodeGroups::Rest::Client.new do |config| config.timeout = 10.0 end
#insert
def insert(request, options = nil) -> ::Gapic::GenericLRO::Operation
def insert(initial_node_count: nil, node_group_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Creates a NodeGroup resource in the specified project using the data included in the request.
def insert(request, options = nil) -> ::Gapic::GenericLRO::Operation
insert
via a request object, either of type
InsertNodeGroupRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::InsertNodeGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def insert(initial_node_count: nil, node_group_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
insert
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- initial_node_count (::Integer) — Initial count of nodes in the node group.
- node_group_resource (::Google::Cloud::Compute::V1::NodeGroup, ::Hash) — The body resource for this request
- project (::String) — Project ID for this request.
- request_id (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- zone (::String) — The name of the zone for this request.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::GenericLRO::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/compute/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Compute::V1::NodeGroups::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Compute::V1::InsertNodeGroupRequest.new # Call the insert method. result = client.insert request # The returned object is of type Google::Cloud::Compute::V1::Operation. p result
#list
def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::NodeGroup>
def list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil, zone: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::NodeGroup>
Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.
def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::NodeGroup>
list
via a request object, either of type
ListNodeGroupsRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::ListNodeGroupsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil, zone: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::NodeGroup>
list
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
filter (::String) — A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either
=
,!=
,>
,<
,<=
,>=
or:
. For example, if you are filtering Compute Engine instances, you can exclude instances namedexample-instance
by specifyingname != example-instance
. The:*
comparison can be used to test whether a key has been defined. For example, to find all objects withowner
label use:labels.owner:*
You can also filter nested fields. For example, you could specifyscheduling.automaticRestart = false
to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example:(scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake")
By default, each expression is anAND
expression. However, you can includeAND
andOR
expressions explicitly. For example:(cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)
If you want to use a regular expression, use theeq
(equal) orne
(not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:fieldname eq unquoted literal
fieldname eq 'single quoted literal'
fieldname eq "double quoted literal"
(fieldname1 eq literal) (fieldname2 ne "literal")
The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would usename ne .*instance
. You cannot combine constraints on multiple fields using regular expressions. -
max_results (::Integer) — The maximum number of results per page that should be returned. If the number of available results is larger than
maxResults
, Compute Engine returns anextPageToken
that can be used to get the next page of results in subsequent list requests. Acceptable values are0
to500
, inclusive. (Default:500
) -
order_by (::String) — Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using
orderBy="creationTimestamp desc"
. This sorts results based on thecreationTimestamp
field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting byname
orcreationTimestamp desc
is supported. -
page_token (::String) — Specifies a page token to use. Set
pageToken
to thenextPageToken
returned by a previous list request to get the next page of results. - project (::String) — Project ID for this request.
- return_partial_success (::Boolean) — Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
- zone (::String) — The name of the zone for this request.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::NodeGroup>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::NodeGroup>)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/compute/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Compute::V1::NodeGroups::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Compute::V1::ListNodeGroupsRequest.new # Call the list method. result = client.list request # The returned object is of type Google::Cloud::Compute::V1::NodeGroupList. p result
#list_nodes
def list_nodes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::NodeGroupNode>
def list_nodes(filter: nil, max_results: nil, node_group: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil, zone: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::NodeGroupNode>
Lists nodes in the node group.
def list_nodes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::NodeGroupNode>
list_nodes
via a request object, either of type
ListNodesNodeGroupsRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::ListNodesNodeGroupsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def list_nodes(filter: nil, max_results: nil, node_group: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil, zone: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::NodeGroupNode>
list_nodes
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
filter (::String) — A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either
=
,!=
,>
,<
,<=
,>=
or:
. For example, if you are filtering Compute Engine instances, you can exclude instances namedexample-instance
by specifyingname != example-instance
. The:*
comparison can be used to test whether a key has been defined. For example, to find all objects withowner
label use:labels.owner:*
You can also filter nested fields. For example, you could specifyscheduling.automaticRestart = false
to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example:(scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake")
By default, each expression is anAND
expression. However, you can includeAND
andOR
expressions explicitly. For example:(cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)
If you want to use a regular expression, use theeq
(equal) orne
(not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:fieldname eq unquoted literal
fieldname eq 'single quoted literal'
fieldname eq "double quoted literal"
(fieldname1 eq literal) (fieldname2 ne "literal")
The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would usename ne .*instance
. You cannot combine constraints on multiple fields using regular expressions. -
max_results (::Integer) — The maximum number of results per page that should be returned. If the number of available results is larger than
maxResults
, Compute Engine returns anextPageToken
that can be used to get the next page of results in subsequent list requests. Acceptable values are0
to500
, inclusive. (Default:500
) - node_group (::String) — Name of the NodeGroup resource whose nodes you want to list.
-
order_by (::String) — Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using
orderBy="creationTimestamp desc"
. This sorts results based on thecreationTimestamp
field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting byname
orcreationTimestamp desc
is supported. -
page_token (::String) — Specifies a page token to use. Set
pageToken
to thenextPageToken
returned by a previous list request to get the next page of results. - project (::String) — Project ID for this request.
- return_partial_success (::Boolean) — Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
- zone (::String) — The name of the zone for this request.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::NodeGroupNode>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::NodeGroupNode>)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/compute/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Compute::V1::NodeGroups::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Compute::V1::ListNodesNodeGroupsRequest.new # Call the list_nodes method. result = client.list_nodes request # The returned object is of type Google::Cloud::Compute::V1::NodeGroupsListNodes. p result
#patch
def patch(request, options = nil) -> ::Gapic::GenericLRO::Operation
def patch(node_group: nil, node_group_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Updates the specified node group.
def patch(request, options = nil) -> ::Gapic::GenericLRO::Operation
patch
via a request object, either of type
PatchNodeGroupRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::PatchNodeGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def patch(node_group: nil, node_group_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
patch
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- node_group (::String) — Name of the NodeGroup resource to update.
- node_group_resource (::Google::Cloud::Compute::V1::NodeGroup, ::Hash) — The body resource for this request
- project (::String) — Project ID for this request.
- request_id (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- zone (::String) — The name of the zone for this request.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::GenericLRO::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/compute/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Compute::V1::NodeGroups::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Compute::V1::PatchNodeGroupRequest.new # Call the patch method. result = client.patch request # The returned object is of type Google::Cloud::Compute::V1::Operation. p result
#set_iam_policy
def set_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
def set_iam_policy(project: nil, resource: nil, zone: nil, zone_set_policy_request_resource: nil) -> ::Google::Cloud::Compute::V1::Policy
Sets the access control policy on the specified resource. Replaces any existing policy.
def set_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
set_iam_policy
via a request object, either of type
SetIamPolicyNodeGroupRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SetIamPolicyNodeGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def set_iam_policy(project: nil, resource: nil, zone: nil, zone_set_policy_request_resource: nil) -> ::Google::Cloud::Compute::V1::Policy
set_iam_policy
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- project (::String) — Project ID for this request.
- resource (::String) — Name or id of the resource for this request.
- zone (::String) — The name of the zone for this request.
- zone_set_policy_request_resource (::Google::Cloud::Compute::V1::ZoneSetPolicyRequest, ::Hash) — The body resource for this request
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Compute::V1::Policy)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/compute/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Compute::V1::NodeGroups::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Compute::V1::SetIamPolicyNodeGroupRequest.new # Call the set_iam_policy method. result = client.set_iam_policy request # The returned object is of type Google::Cloud::Compute::V1::Policy. p result
#set_node_template
def set_node_template(request, options = nil) -> ::Gapic::GenericLRO::Operation
def set_node_template(node_group: nil, node_groups_set_node_template_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Updates the node template of the node group.
def set_node_template(request, options = nil) -> ::Gapic::GenericLRO::Operation
set_node_template
via a request object, either of type
SetNodeTemplateNodeGroupRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SetNodeTemplateNodeGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def set_node_template(node_group: nil, node_groups_set_node_template_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
set_node_template
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- node_group (::String) — Name of the NodeGroup resource to update.
- node_groups_set_node_template_request_resource (::Google::Cloud::Compute::V1::NodeGroupsSetNodeTemplateRequest, ::Hash) — The body resource for this request
- project (::String) — Project ID for this request.
- request_id (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- zone (::String) — The name of the zone for this request.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::GenericLRO::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/compute/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Compute::V1::NodeGroups::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Compute::V1::SetNodeTemplateNodeGroupRequest.new # Call the set_node_template method. result = client.set_node_template request # The returned object is of type Google::Cloud::Compute::V1::Operation. p result
#simulate_maintenance_event
def simulate_maintenance_event(request, options = nil) -> ::Gapic::GenericLRO::Operation
def simulate_maintenance_event(node_group: nil, node_groups_simulate_maintenance_event_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Simulates maintenance event on specified nodes from the node group.
def simulate_maintenance_event(request, options = nil) -> ::Gapic::GenericLRO::Operation
simulate_maintenance_event
via a request object, either of type
SimulateMaintenanceEventNodeGroupRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SimulateMaintenanceEventNodeGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def simulate_maintenance_event(node_group: nil, node_groups_simulate_maintenance_event_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
simulate_maintenance_event
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- node_group (::String) — Name of the NodeGroup resource whose nodes will go under maintenance simulation.
- node_groups_simulate_maintenance_event_request_resource (::Google::Cloud::Compute::V1::NodeGroupsSimulateMaintenanceEventRequest, ::Hash) — The body resource for this request
- project (::String) — Project ID for this request.
- request_id (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
- zone (::String) — The name of the zone for this request.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::GenericLRO::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/compute/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Compute::V1::NodeGroups::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Compute::V1::SimulateMaintenanceEventNodeGroupRequest.new # Call the simulate_maintenance_event method. result = client.simulate_maintenance_event request # The returned object is of type Google::Cloud::Compute::V1::Operation. p result
#test_iam_permissions
def test_iam_permissions(request, options = nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
def test_iam_permissions(project: nil, resource: nil, test_permissions_request_resource: nil, zone: nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
Returns permissions that a caller has on the specified resource.
def test_iam_permissions(request, options = nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
test_iam_permissions
via a request object, either of type
TestIamPermissionsNodeGroupRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::TestIamPermissionsNodeGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def test_iam_permissions(project: nil, resource: nil, test_permissions_request_resource: nil, zone: nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
test_iam_permissions
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- project (::String) — Project ID for this request.
- resource (::String) — Name or id of the resource for this request.
- test_permissions_request_resource (::Google::Cloud::Compute::V1::TestPermissionsRequest, ::Hash) — The body resource for this request
- zone (::String) — The name of the zone for this request.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Compute::V1::TestPermissionsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/compute/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Compute::V1::NodeGroups::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Compute::V1::TestIamPermissionsNodeGroupRequest.new # Call the test_iam_permissions method. result = client.test_iam_permissions request # The returned object is of type Google::Cloud::Compute::V1::TestPermissionsResponse. p result
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#zone_operations
def zone_operations() -> ::Google::Cloud::Compute::V1::ZoneOperations::Rest::Client
Get the associated client for long-running operations via ZoneOperations.