Class: Google::Apis::GkeonpremV1::GKEOnPremService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/gkeonprem_v1/service.rb

Overview

GKE On-Prem API

Examples:

require 'google/apis/gkeonprem_v1'

Gkeonprem = Google::Apis::GkeonpremV1 # Alias the module
service = Gkeonprem::GKEOnPremService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://gkeonprem.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ GKEOnPremService

Returns a new instance of GKEOnPremService.



47
48
49
50
51
52
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-gkeonprem_v1',
        client_version: Google::Apis::GkeonpremV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



40
41
42
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



45
46
47
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Empty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1 , corresponding to Code.CANCELLED.

Parameters:

  • name (String) —

    The name of the operation resource to be cancelled.

  • cancel_operation_request_object (Google::Apis::GkeonpremV1::CancelOperationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1767

def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::GkeonpremV1::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  command.response_representation = Google::Apis::GkeonpremV1::Empty::Representation
  command.response_class = Google::Apis::GkeonpremV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_bare_metal_admin_cluster(parent, bare_metal_admin_cluster_object = nil, allow_preflight_failure: nil, bare_metal_admin_cluster_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Creates a new bare metal admin cluster in a given project and location. The API needs to be combined with creating a bootstrap cluster to work. See: https: //cloud.google.com/anthos/clusters/docs/bare-metal/latest/installing/creating- clusters/create-admin-cluster-api#prepare_bootstrap_environment

Parameters:

  • parent (String) —

    Required. The parent of the project and location where the cluster is created in. Format: "projects/project/locations/location"

  • bare_metal_admin_cluster_object (Google::Apis::GkeonpremV1::BareMetalAdminCluster) (defaults to: nil)
  • allow_preflight_failure (Boolean) (defaults to: nil) —

    Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with "cluster already exists" error and hence a update cluster is required to fix the cluster.

  • bare_metal_admin_cluster_id (String) (defaults to: nil) —

    Required. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/

  • validate_only (Boolean) (defaults to: nil) —

    Validate the request without actually doing any updates.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 167

def create_project_location_bare_metal_admin_cluster(parent, bare_metal_admin_cluster_object = nil, allow_preflight_failure: nil, bare_metal_admin_cluster_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/bareMetalAdminClusters', options)
  command.request_representation = Google::Apis::GkeonpremV1::BareMetalAdminCluster::Representation
  command.request_object = bare_metal_admin_cluster_object
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['allowPreflightFailure'] = allow_preflight_failure unless allow_preflight_failure.nil?
  command.query['bareMetalAdminClusterId'] = bare_metal_admin_cluster_id unless bare_metal_admin_cluster_id.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_bare_metal_cluster(parent, bare_metal_cluster_object = nil, allow_preflight_failure: nil, bare_metal_cluster_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Creates a new bare metal cluster in a given project and location.

Parameters:

  • parent (String) —

    Required. The parent of the project and location where the cluster is created in. Format: "projects/project/locations/location"

  • bare_metal_cluster_object (Google::Apis::GkeonpremV1::BareMetalCluster) (defaults to: nil)
  • allow_preflight_failure (Boolean) (defaults to: nil) —

    Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with "cluster already exists" error and hence a update cluster is required to fix the cluster.

  • bare_metal_cluster_id (String) (defaults to: nil) —

    Required. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/

  • validate_only (Boolean) (defaults to: nil) —

    Validate the request without actually doing any updates.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



680
681
682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 680

def create_project_location_bare_metal_cluster(parent, bare_metal_cluster_object = nil, allow_preflight_failure: nil, bare_metal_cluster_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/bareMetalClusters', options)
  command.request_representation = Google::Apis::GkeonpremV1::BareMetalCluster::Representation
  command.request_object = bare_metal_cluster_object
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['allowPreflightFailure'] = allow_preflight_failure unless allow_preflight_failure.nil?
  command.query['bareMetalClusterId'] = bare_metal_cluster_id unless bare_metal_cluster_id.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_bare_metal_cluster_bare_metal_node_pool(parent, bare_metal_node_pool_object = nil, bare_metal_node_pool_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Creates a new bare metal node pool in a given project, location and Bare Metal cluster.

Parameters:

  • parent (String) —

    Required. The parent resource where this node pool will be created. projects/ project/locations/location/bareMetalClusters/cluster

  • bare_metal_node_pool_object (Google::Apis::GkeonpremV1::BareMetalNodePool) (defaults to: nil)
  • bare_metal_node_pool_id (String) (defaults to: nil) —

    The ID to use for the node pool, which will become the final component of the node pool's resource name. This value must be up to 63 characters, and valid characters are /a-z-/. The value must not be permitted to be a UUID (or UUID- like: anything matching /^[0-9a-f]8(-[0-9a-f]4)3-[0-9a-f]12$/i).

  • validate_only (Boolean) (defaults to: nil) —

    If set, only validate the request, but do not actually create the node pool.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1179

def create_project_location_bare_metal_cluster_bare_metal_node_pool(parent, bare_metal_node_pool_object = nil, bare_metal_node_pool_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/bareMetalNodePools', options)
  command.request_representation = Google::Apis::GkeonpremV1::BareMetalNodePool::Representation
  command.request_object = bare_metal_node_pool_object
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['bareMetalNodePoolId'] = bare_metal_node_pool_id unless bare_metal_node_pool_id.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_vmware_admin_cluster(parent, vmware_admin_cluster_object = nil, allow_preflight_failure: nil, skip_validations: nil, validate_only: nil, vmware_admin_cluster_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Creates a new VMware admin cluster in a given project and location. The API needs to be combined with creating a bootstrap cluster to work.

Parameters:

  • parent (String) —

    Required. The parent of the project and location where the cluster is created in. Format: "projects/project/locations/location"

  • vmware_admin_cluster_object (Google::Apis::GkeonpremV1::VmwareAdminCluster) (defaults to: nil)
  • allow_preflight_failure (Boolean) (defaults to: nil) —

    Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with "cluster already exists" error and hence a update cluster is required to fix the cluster.

  • skip_validations (Array<String>, String) (defaults to: nil) —

    Optional. If set, skip the specified validations.

  • validate_only (Boolean) (defaults to: nil) —

    Validate the request without actually doing any updates.

  • vmware_admin_cluster_id (String) (defaults to: nil) —

    Required. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1927

def create_project_location_vmware_admin_cluster(parent, vmware_admin_cluster_object = nil, allow_preflight_failure: nil, skip_validations: nil, validate_only: nil, vmware_admin_cluster_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/vmwareAdminClusters', options)
  command.request_representation = Google::Apis::GkeonpremV1::VmwareAdminCluster::Representation
  command.request_object = vmware_admin_cluster_object
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['allowPreflightFailure'] = allow_preflight_failure unless allow_preflight_failure.nil?
  command.query['skipValidations'] = skip_validations unless skip_validations.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['vmwareAdminClusterId'] = vmware_admin_cluster_id unless vmware_admin_cluster_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_vmware_cluster(parent, vmware_cluster_object = nil, allow_preflight_failure: nil, skip_validations: nil, validate_only: nil, vmware_cluster_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Creates a new VMware user cluster in a given project and location.

Parameters:

  • parent (String) —

    Required. The parent of the project and location where this cluster is created in. Format: "projects/project/locations/location"

  • vmware_cluster_object (Google::Apis::GkeonpremV1::VmwareCluster) (defaults to: nil)
  • allow_preflight_failure (Boolean) (defaults to: nil) —

    Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with "cluster already exists" error and hence a update cluster is required to fix the cluster.

  • skip_validations (Array<String>, String) (defaults to: nil) —

    Optional. List of validations to skip during cluster creation.

  • validate_only (Boolean) (defaults to: nil) —

    Validate the request without actually doing any updates.

  • vmware_cluster_id (String) (defaults to: nil) —

    User provided identifier that is used as part of the resource name; This value must be up to 40 characters and follow RFC-1123 (https://tools.ietf.org/html/ rfc1123) format.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2408

def create_project_location_vmware_cluster(parent, vmware_cluster_object = nil, allow_preflight_failure: nil, skip_validations: nil, validate_only: nil, vmware_cluster_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/vmwareClusters', options)
  command.request_representation = Google::Apis::GkeonpremV1::VmwareCluster::Representation
  command.request_object = vmware_cluster_object
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['allowPreflightFailure'] = allow_preflight_failure unless allow_preflight_failure.nil?
  command.query['skipValidations'] = skip_validations unless skip_validations.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['vmwareClusterId'] = vmware_cluster_id unless vmware_cluster_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_vmware_cluster_vmware_node_pool(parent, vmware_node_pool_object = nil, validate_only: nil, vmware_node_pool_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Creates a new VMware node pool in a given project, location and VMWare cluster.

Parameters:

  • parent (String) —

    Required. The parent resource where this node pool will be created. projects/ project/locations/location/vmwareClusters/cluster

  • vmware_node_pool_object (Google::Apis::GkeonpremV1::VmwareNodePool) (defaults to: nil)
  • validate_only (Boolean) (defaults to: nil) —

    If set, only validate the request, but do not actually create the node pool.

  • vmware_node_pool_id (String) (defaults to: nil) —

    The ID to use for the node pool, which will become the final component of the node pool's resource name. This value must be up to 40 characters and follow RFC-1123 (https://tools.ietf.org/html/rfc1123) format. The value must not be permitted to be a UUID (or UUID-like: anything matching /^[0-9a-f]8(-[0-9a-f] 4)3-[0-9a-f]12$/i).

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2983

def create_project_location_vmware_cluster_vmware_node_pool(parent, vmware_node_pool_object = nil, validate_only: nil, vmware_node_pool_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/vmwareNodePools', options)
  command.request_representation = Google::Apis::GkeonpremV1::VmwareNodePool::Representation
  command.request_object = vmware_node_pool_object
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['vmwareNodePoolId'] = vmware_node_pool_id unless vmware_node_pool_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_bare_metal_cluster(name, allow_missing: nil, etag: nil, force: nil, ignore_errors: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Deletes a single bare metal Cluster.

Parameters:

  • name (String) —

    Required. Name of the bare metal user cluster to be deleted. Format: "projects/ project/locations/location/bareMetalClusters/bare_metal_cluster"

  • allow_missing (Boolean) (defaults to: nil) —

    If set to true, and the bare metal cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.

  • etag (String) (defaults to: nil) —

    The current etag of the bare metal Cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.

  • force (Boolean) (defaults to: nil) —

    If set to true, any node pools from the cluster will also be deleted.

  • ignore_errors (Boolean) (defaults to: nil) —

    If set to true, the deletion of a bare metal user cluster resource will succeed even if errors occur during deletion. This parameter can be used when you want to delete GCP's cluster resource and the on-prem admin cluster that hosts your user cluster is disconnected / unreachable or deleted. WARNING: Using this parameter when your user cluster still exists may result in a deleted GCP user cluster but an existing on-prem user cluster.

  • validate_only (Boolean) (defaults to: nil) —

    Validate the request without actually doing any updates.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



734
735
736
737
738
739
740
741
742
743
744
745
746
747
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 734

def delete_project_location_bare_metal_cluster(name, allow_missing: nil, etag: nil, force: nil, ignore_errors: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['force'] = force unless force.nil?
  command.query['ignoreErrors'] = ignore_errors unless ignore_errors.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_bare_metal_cluster_bare_metal_node_pool(name, allow_missing: nil, etag: nil, ignore_errors: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Deletes a single bare metal node pool.

Parameters:

  • name (String) —

    Required. The name of the node pool to delete. Format: projects/project/ locations/location/bareMetalClusters/cluster/bareMetalNodePools/nodepool

  • allow_missing (Boolean) (defaults to: nil) —

    If set to true, and the bare metal node pool is not found, the request will succeed but no action will be taken on the server and return a completed LRO.

  • etag (String) (defaults to: nil) —

    The current etag of the BareMetalNodePool. If an etag is provided and does not match the current etag of the node pool, deletion will be blocked and an ABORTED error will be returned.

  • ignore_errors (Boolean) (defaults to: nil) —

    If set to true, the deletion of a bare metal node pool resource will succeed even if errors occur during deletion. This parameter can be used when you want to delete GCP's node pool resource and you've already deleted the on-prem admin cluster that hosted your node pool. WARNING: Using this parameter when your user cluster still exists may result in a deleted GCP node pool but an existing on-prem node pool.

  • validate_only (Boolean) (defaults to: nil) —

    If set, only validate the request, but do not actually delete the node pool.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1230

def delete_project_location_bare_metal_cluster_bare_metal_node_pool(name, allow_missing: nil, etag: nil, ignore_errors: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['ignoreErrors'] = ignore_errors unless ignore_errors.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Empty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1802
1803
1804
1805
1806
1807
1808
1809
1810
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1802

def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkeonpremV1::Empty::Representation
  command.response_class = Google::Apis::GkeonpremV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_vmware_cluster(name, allow_missing: nil, etag: nil, force: nil, ignore_errors: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Deletes a single VMware Cluster.

Parameters:

  • name (String) —

    Required. Name of the VMware user cluster to be deleted. Format: "projects/ project/locations/location/vmwareClusters/vmware_cluster"

  • allow_missing (Boolean) (defaults to: nil) —

    If set to true, and the VMware cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.

  • etag (String) (defaults to: nil) —

    The current etag of the VMware cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.

  • force (Boolean) (defaults to: nil) —

    If set to true, any node pools from the cluster will also be deleted.

  • ignore_errors (Boolean) (defaults to: nil) —

    If set to true, the deletion of a VMware user cluster resource will succeed even if errors occur during deletion. This parameter can be used when you want to delete GCP's cluster resource and the on-prem admin cluster that hosts your user cluster is disconnected / unreachable or deleted. WARNING: Using this parameter when your user cluster still exists may result in a deleted GCP user cluster but an existing on-prem user cluster.

  • validate_only (Boolean) (defaults to: nil) —

    Validate the request without actually doing any updates.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2463

def delete_project_location_vmware_cluster(name, allow_missing: nil, etag: nil, force: nil, ignore_errors: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['force'] = force unless force.nil?
  command.query['ignoreErrors'] = ignore_errors unless ignore_errors.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_vmware_cluster_vmware_node_pool(name, allow_missing: nil, etag: nil, ignore_errors: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Deletes a single VMware node pool.

Parameters:

  • name (String) —

    Required. The name of the node pool to delete. Format: projects/project/ locations/location/vmwareClusters/cluster/vmwareNodePools/nodepool

  • allow_missing (Boolean) (defaults to: nil) —

    If set to true, and the VMware node pool is not found, the request will succeed but no action will be taken on the server and return a completed LRO.

  • etag (String) (defaults to: nil) —

    The current etag of the VmwareNodePool. If an etag is provided and does not match the current etag of the node pool, deletion will be blocked and an ABORTED error will be returned.

  • ignore_errors (Boolean) (defaults to: nil) —

    If set to true, the deletion of a VMware node pool resource will succeed even if errors occur during deletion. This parameter can be used when you want to delete GCP's node pool resource and you've already deleted the on-prem admin cluster that hosted your node pool. WARNING: Using this parameter when your user cluster still exists may result in a deleted GCP node pool but an existing on-prem node pool.

  • validate_only (Boolean) (defaults to: nil) —

    If set, only validate the request, but do not actually delete the node pool.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 3034

def delete_project_location_vmware_cluster_vmware_node_pool(name, allow_missing: nil, etag: nil, ignore_errors: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['ignoreErrors'] = ignore_errors unless ignore_errors.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#enroll_bare_metal_admin_cluster(parent, enroll_bare_metal_admin_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Enrolls an existing bare metal admin cluster to the Anthos On-Prem API within a given project and location. Through enrollment, an existing admin cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster will be expected to be performed through the API.

Parameters:

  • parent (String) —

    Required. The parent of the project and location where the cluster is enrolled in. Format: "projects/project/locations/location"

  • enroll_bare_metal_admin_cluster_request_object (Google::Apis::GkeonpremV1::EnrollBareMetalAdminClusterRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 208

def enroll_bare_metal_admin_cluster(parent, enroll_bare_metal_admin_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/bareMetalAdminClusters:enroll', options)
  command.request_representation = Google::Apis::GkeonpremV1::EnrollBareMetalAdminClusterRequest::Representation
  command.request_object = enroll_bare_metal_admin_cluster_request_object
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#enroll_bare_metal_cluster(parent, enroll_bare_metal_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Enrolls an existing bare metal user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API.

Parameters:

  • parent (String) —

    Required. The parent of the project and location where the cluster is enrolled in. Format: "projects/project/locations/location"

  • enroll_bare_metal_cluster_request_object (Google::Apis::GkeonpremV1::EnrollBareMetalClusterRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



775
776
777
778
779
780
781
782
783
784
785
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 775

def enroll_bare_metal_cluster(parent, enroll_bare_metal_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/bareMetalClusters:enroll', options)
  command.request_representation = Google::Apis::GkeonpremV1::EnrollBareMetalClusterRequest::Representation
  command.request_object = enroll_bare_metal_cluster_request_object
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#enroll_bare_metal_node_pool(parent, enroll_bare_metal_node_pool_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Enrolls an existing bare metal node pool to the Anthos On-Prem API within a given project and location. Through enrollment, an existing node pool will become Anthos On-Prem API managed. The corresponding GCP resources will be created.

Parameters:

  • parent (String) —

    Required. The parent resource where this node pool will be created. projects/ project/locations/location/bareMetalClusters/cluster

  • enroll_bare_metal_node_pool_request_object (Google::Apis::GkeonpremV1::EnrollBareMetalNodePoolRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1269

def enroll_bare_metal_node_pool(parent, enroll_bare_metal_node_pool_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/bareMetalNodePools:enroll', options)
  command.request_representation = Google::Apis::GkeonpremV1::EnrollBareMetalNodePoolRequest::Representation
  command.request_object = enroll_bare_metal_node_pool_request_object
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#enroll_vmware_admin_cluster(parent, enroll_vmware_admin_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Enrolls an existing VMware admin cluster to the Anthos On-Prem API within a given project and location. Through enrollment, an existing admin cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster will be expected to be performed through the API.

Parameters:

  • parent (String) —

    Required. The parent of the project and location where the cluster is enrolled in. Format: "projects/project/locations/location"

  • enroll_vmware_admin_cluster_request_object (Google::Apis::GkeonpremV1::EnrollVmwareAdminClusterRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1969

def enroll_vmware_admin_cluster(parent, enroll_vmware_admin_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/vmwareAdminClusters:enroll', options)
  command.request_representation = Google::Apis::GkeonpremV1::EnrollVmwareAdminClusterRequest::Representation
  command.request_object = enroll_vmware_admin_cluster_request_object
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#enroll_vmware_cluster(parent, enroll_vmware_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Enrolls an existing VMware user cluster and its node pools to the Anthos On- Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API.

Parameters:

  • parent (String) —

    Required. The parent of the project and location where the cluster is Enrolled in. Format: "projects/project/locations/location"

  • enroll_vmware_cluster_request_object (Google::Apis::GkeonpremV1::EnrollVmwareClusterRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2504

def enroll_vmware_cluster(parent, enroll_vmware_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/vmwareClusters:enroll', options)
  command.request_representation = Google::Apis::GkeonpremV1::EnrollVmwareClusterRequest::Representation
  command.request_object = enroll_vmware_cluster_request_object
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#enroll_vmware_node_pool(parent, enroll_vmware_node_pool_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Enrolls a VMware node pool to Anthos On-Prem API

Parameters:

  • parent (String) —

    Required. The parent resource where the node pool is enrolled in.

  • enroll_vmware_node_pool_request_object (Google::Apis::GkeonpremV1::EnrollVmwareNodePoolRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 3069

def enroll_vmware_node_pool(parent, enroll_vmware_node_pool_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/vmwareNodePools:enroll', options)
  command.request_representation = Google::Apis::GkeonpremV1::EnrollVmwareNodePoolRequest::Representation
  command.request_object = enroll_vmware_node_pool_request_object
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Location

Gets information about a location.

Parameters:

  • name (String) —

    Resource name for the location.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



74
75
76
77
78
79
80
81
82
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 74

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkeonpremV1::Location::Representation
  command.response_class = Google::Apis::GkeonpremV1::Location
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_bare_metal_admin_cluster(name, allow_missing: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::BareMetalAdminCluster

Gets details of a single bare metal admin cluster.

Parameters:

  • name (String) —

    Required. Name of the bare metal admin cluster to get. Format: "projects/ project/locations/location/bareMetalAdminClusters/bare_metal_admin_cluster "

  • allow_missing (Boolean) (defaults to: nil) —

    Optional. If true, return BareMetal Admin Cluster including the one that only exists in RMS.

  • view (String) (defaults to: nil) —

    View for bare metal admin cluster. When BASIC is specified, only the cluster resource name and membership are returned. The default/unset value CLUSTER_VIEW_UNSPECIFIED is the same as `FULL', which returns the complete cluster configuration details.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 250

def get_project_location_bare_metal_admin_cluster(name, allow_missing: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkeonpremV1::BareMetalAdminCluster::Representation
  command.response_class = Google::Apis::GkeonpremV1::BareMetalAdminCluster
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_bare_metal_admin_cluster_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil) —

    Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



296
297
298
299
300
301
302
303
304
305
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 296

def get_project_location_bare_metal_admin_cluster_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::GkeonpremV1::Policy::Representation
  command.response_class = Google::Apis::GkeonpremV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_bare_metal_admin_cluster_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



589
590
591
592
593
594
595
596
597
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 589

def get_project_location_bare_metal_admin_cluster_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_bare_metal_cluster(name, allow_missing: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::BareMetalCluster

Gets details of a single bare metal Cluster.

Parameters:

  • name (String) —

    Required. Name of the bare metal user cluster to get. Format: "projects/ project/locations/location/bareMetalClusters/bare_metal_cluster"

  • allow_missing (Boolean) (defaults to: nil) —

    Optional. If true, return BareMetal Cluster including the one that only exists in RMS.

  • view (String) (defaults to: nil) —

    View for bare metal user cluster. When BASIC is specified, only the cluster resource name and admin cluster membership are returned. The default/unset value CLUSTER_VIEW_UNSPECIFIED is the same as `FULL', which returns the complete cluster configuration details.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 816

def get_project_location_bare_metal_cluster(name, allow_missing: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkeonpremV1::BareMetalCluster::Representation
  command.response_class = Google::Apis::GkeonpremV1::BareMetalCluster
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_bare_metal_cluster_bare_metal_node_pool(name, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::BareMetalNodePool

Gets details of a single bare metal node pool.

Parameters:

  • name (String) —

    Required. The name of the node pool to retrieve. projects/project/locations/ location/bareMetalClusters/cluster/bareMetalNodePools/nodepool

  • view (String) (defaults to: nil) —

    View for bare metal node pool. When BASIC is specified, only the node pool resource name is returned. The default/unset value NODE_POOL_VIEW_UNSPECIFIED is the same as `FULL', which returns the complete node pool configuration details.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1307

def get_project_location_bare_metal_cluster_bare_metal_node_pool(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkeonpremV1::BareMetalNodePool::Representation
  command.response_class = Google::Apis::GkeonpremV1::BareMetalNodePool
  command.params['name'] = name unless name.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_bare_metal_cluster_bare_metal_node_pool_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil) —

    Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1352

def get_project_location_bare_metal_cluster_bare_metal_node_pool_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::GkeonpremV1::Policy::Representation
  command.response_class = Google::Apis::GkeonpremV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_bare_metal_cluster_bare_metal_node_pool_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1602
1603
1604
1605
1606
1607
1608
1609
1610
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1602

def get_project_location_bare_metal_cluster_bare_metal_node_pool_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_bare_metal_cluster_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil) —

    Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



862
863
864
865
866
867
868
869
870
871
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 862

def get_project_location_bare_metal_cluster_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::GkeonpremV1::Policy::Representation
  command.response_class = Google::Apis::GkeonpremV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_bare_metal_cluster_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1681
1682
1683
1684
1685
1686
1687
1688
1689
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1681

def get_project_location_bare_metal_cluster_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1833
1834
1835
1836
1837
1838
1839
1840
1841
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1833

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_vmware_admin_cluster(name, allow_missing: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::VmwareAdminCluster

Gets details of a single VMware admin cluster.

Parameters:

  • name (String) —

    Required. Name of the VMware admin cluster to be returned. Format: "projects/ project/locations/location/vmwareAdminClusters/vmware_admin_cluster"

  • allow_missing (Boolean) (defaults to: nil) —

    Optional. If true, return Vmware Admin Cluster including the one that only exists in RMS.

  • view (String) (defaults to: nil) —

    View for VMware admin cluster. When BASIC is specified, only the cluster resource name and membership are returned. The default/unset value CLUSTER_VIEW_UNSPECIFIED is the same as `FULL', which returns the complete cluster configuration details.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2010

def get_project_location_vmware_admin_cluster(name, allow_missing: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkeonpremV1::VmwareAdminCluster::Representation
  command.response_class = Google::Apis::GkeonpremV1::VmwareAdminCluster
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_vmware_admin_cluster_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil) —

    Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2056

def get_project_location_vmware_admin_cluster_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::GkeonpremV1::Policy::Representation
  command.response_class = Google::Apis::GkeonpremV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_vmware_admin_cluster_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2315
2316
2317
2318
2319
2320
2321
2322
2323
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2315

def get_project_location_vmware_admin_cluster_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_vmware_cluster(name, allow_missing: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::VmwareCluster

Gets details of a single VMware Cluster.

Parameters:

  • name (String) —

    Required. Name of the VMware user cluster to be returned. Format: "projects/ project/locations/location/vmwareClusters/vmware_cluster"

  • allow_missing (Boolean) (defaults to: nil) —

    Optional. If true, return Vmware Cluster including the one that only exists in RMS.

  • view (String) (defaults to: nil) —

    View for VMware user cluster. When BASIC is specified, only the cluster resource name and admin cluster membership are returned. The default/unset value CLUSTER_VIEW_UNSPECIFIED is the same as `FULL', which returns the complete cluster configuration details.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2545

def get_project_location_vmware_cluster(name, allow_missing: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkeonpremV1::VmwareCluster::Representation
  command.response_class = Google::Apis::GkeonpremV1::VmwareCluster
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_vmware_cluster_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil) —

    Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2591

def get_project_location_vmware_cluster_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::GkeonpremV1::Policy::Representation
  command.response_class = Google::Apis::GkeonpremV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_vmware_cluster_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2895
2896
2897
2898
2899
2900
2901
2902
2903
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2895

def get_project_location_vmware_cluster_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_vmware_cluster_vmware_node_pool(name, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::VmwareNodePool

Gets details of a single VMware node pool.

Parameters:

  • name (String) —

    Required. The name of the node pool to retrieve. projects/project/locations/ location/vmwareClusters/cluster/vmwareNodePools/nodepool

  • view (String) (defaults to: nil) —

    View for VMware node pool. When BASIC is specified, only the node pool resource name is returned. The default/unset value NODE_POOL_VIEW_UNSPECIFIED is the same as `FULL', which returns the complete node pool configuration details.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 3107

def get_project_location_vmware_cluster_vmware_node_pool(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkeonpremV1::VmwareNodePool::Representation
  command.response_class = Google::Apis::GkeonpremV1::VmwareNodePool
  command.params['name'] = name unless name.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_vmware_cluster_vmware_node_pool_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil) —

    Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 3152

def get_project_location_vmware_cluster_vmware_node_pool_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::GkeonpremV1::Policy::Representation
  command.response_class = Google::Apis::GkeonpremV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_vmware_cluster_vmware_node_pool_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3395
3396
3397
3398
3399
3400
3401
3402
3403
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 3395

def get_project_location_vmware_cluster_vmware_node_pool_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_bare_metal_admin_cluster_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • return_partial_success (Boolean) (defaults to: nil) —

    When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse. unreachable] field. This can only be true when reading across collections e. g. when parent is set to "projects/example/locations/-". This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 633

def list_project_location_bare_metal_admin_cluster_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::GkeonpremV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_bare_metal_admin_clusters(parent, allow_missing: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::ListBareMetalAdminClustersResponse

Lists bare metal admin clusters in a given project and location.

Parameters:

  • parent (String) —

    Required. The parent of the project and location where the clusters are listed in. Format: "projects/project/locations/location"

  • allow_missing (Boolean) (defaults to: nil) —

    Optional. If true, return list of BareMetal Admin Clusters including the ones that only exists in RMS.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return.

  • view (String) (defaults to: nil) —

    View for bare metal admin clusters. When BASIC is specified, only the admin cluster resource name and membership are returned. The default/unset value CLUSTER_VIEW_UNSPECIFIED is the same as `FULL', which returns the complete admin cluster configuration details.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 342

def list_project_location_bare_metal_admin_clusters(parent, allow_missing: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/bareMetalAdminClusters', options)
  command.response_representation = Google::Apis::GkeonpremV1::ListBareMetalAdminClustersResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::ListBareMetalAdminClustersResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_bare_metal_cluster_bare_metal_node_pool_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • return_partial_success (Boolean) (defaults to: nil) —

    When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse. unreachable] field. This can only be true when reading across collections e. g. when parent is set to "projects/example/locations/-". This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1646

def list_project_location_bare_metal_cluster_bare_metal_node_pool_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::GkeonpremV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_bare_metal_cluster_bare_metal_node_pools(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::ListBareMetalNodePoolsResponse

Lists bare metal node pools in a given project, location and bare metal cluster.

Parameters:

  • parent (String) —

    Required. The parent, which owns this collection of node pools. Format: projects/project/locations/location/bareMetalClusters/bareMetalCluster

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of node pools to return. The service may return fewer than this value. If unspecified, at most 50 node pools will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListBareMetalNodePools call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBareMetalNodePools must match the call that provided the page token.

  • view (String) (defaults to: nil) —

    View for bare metal node pools. When BASIC is specified, only the node pool resource name is returned. The default/unset value NODE_POOL_VIEW_UNSPECIFIED is the same as `FULL', which returns the complete node pool configuration details.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1399

def list_project_location_bare_metal_cluster_bare_metal_node_pools(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/bareMetalNodePools', options)
  command.response_representation = Google::Apis::GkeonpremV1::ListBareMetalNodePoolsResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::ListBareMetalNodePoolsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_bare_metal_cluster_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • return_partial_success (Boolean) (defaults to: nil) —

    When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse. unreachable] field. This can only be true when reading across collections e. g. when parent is set to "projects/example/locations/-". This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1725

def list_project_location_bare_metal_cluster_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::GkeonpremV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_bare_metal_clusters(parent, allow_missing: nil, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::ListBareMetalClustersResponse

Lists bare metal clusters in a given project and location.

Parameters:

  • parent (String) —

    Required. The parent of the project and location where the clusters are listed in. Format: "projects/project/locations/location"

  • allow_missing (Boolean) (defaults to: nil) —

    Optional. If true, return list of BareMetal Clusters including the ones that only exists in RMS.

  • filter (String) (defaults to: nil) —

    A resource filtering expression following https://google.aip.dev/160. When non- empty, only resource's whose attributes field matches the filter are returned.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return.

  • view (String) (defaults to: nil) —

    View for bare metal Clusters. When BASIC is specified, only the cluster resource name and admin cluster membership are returned. The default/unset value CLUSTER_VIEW_UNSPECIFIED is the same as `FULL', which returns the complete cluster configuration details.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



911
912
913
914
915
916
917
918
919
920
921
922
923
924
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 911

def list_project_location_bare_metal_clusters(parent, allow_missing: nil, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/bareMetalClusters', options)
  command.response_representation = Google::Apis::GkeonpremV1::ListBareMetalClustersResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::ListBareMetalClustersResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • return_partial_success (Boolean) (defaults to: nil) —

    When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse. unreachable] field. This can only be true when reading across collections e. g. when parent is set to "projects/example/locations/-". This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1877

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::GkeonpremV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_vmware_admin_cluster_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • return_partial_success (Boolean) (defaults to: nil) —

    When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse. unreachable] field. This can only be true when reading across collections e. g. when parent is set to "projects/example/locations/-". This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2359

def list_project_location_vmware_admin_cluster_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::GkeonpremV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_vmware_admin_clusters(parent, allow_missing: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::ListVmwareAdminClustersResponse

Lists VMware admin clusters in a given project and location.

Parameters:

  • parent (String) —

    Required. The parent of the project and location where the clusters are listed in. Format: "projects/project/locations/location"

  • allow_missing (Boolean) (defaults to: nil) —

    Optional. If true, return list of Vmware Admin Clusters including the ones that only exists in RMS.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return.

  • view (String) (defaults to: nil) —

    View for VMware admin clusters. When BASIC is specified, only the admin cluster resource name and membership are returned. The default/unset value CLUSTER_VIEW_UNSPECIFIED is the same as `FULL', which returns the complete admin cluster configuration details.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2102

def list_project_location_vmware_admin_clusters(parent, allow_missing: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/vmwareAdminClusters', options)
  command.response_representation = Google::Apis::GkeonpremV1::ListVmwareAdminClustersResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::ListVmwareAdminClustersResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_vmware_cluster_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • return_partial_success (Boolean) (defaults to: nil) —

    When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse. unreachable] field. This can only be true when reading across collections e. g. when parent is set to "projects/example/locations/-". This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2939

def list_project_location_vmware_cluster_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::GkeonpremV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_vmware_cluster_vmware_node_pool_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • return_partial_success (Boolean) (defaults to: nil) —

    When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse. unreachable] field. This can only be true when reading across collections e. g. when parent is set to "projects/example/locations/-". This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 3439

def list_project_location_vmware_cluster_vmware_node_pool_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::GkeonpremV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_vmware_cluster_vmware_node_pools(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::ListVmwareNodePoolsResponse

Lists VMware node pools in a given project, location and VMWare cluster.

Parameters:

  • parent (String) —

    Required. The parent, which owns this collection of node pools. Format: projects/project/locations/location/vmwareClusters/vmwareCluster

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of node pools to return. The service may return fewer than this value. If unspecified, at most 50 node pools will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListVmwareNodePools call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListVmwareNodePools must match the call that provided the page token.

  • view (String) (defaults to: nil) —

    View for VMware node pools. When BASIC is specified, only the node pool resource name is returned. The default/unset value NODE_POOL_VIEW_UNSPECIFIED is the same as `FULL', which returns the complete node pool configuration details.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 3198

def list_project_location_vmware_cluster_vmware_node_pools(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/vmwareNodePools', options)
  command.response_representation = Google::Apis::GkeonpremV1::ListVmwareNodePoolsResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::ListVmwareNodePoolsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_vmware_clusters(parent, allow_missing: nil, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::ListVmwareClustersResponse

Lists VMware Clusters in a given project and location.

Parameters:

  • parent (String) —

    Required. The parent of the project and location where the clusters are listed in. Format: "projects/project/locations/location"

  • allow_missing (Boolean) (defaults to: nil) —

    Optional. If true, return list of Vmware Clusters including the ones that only exists in RMS.

  • filter (String) (defaults to: nil) —

    A resource filtering expression following https://google.aip.dev/160. When non- empty, only resource's whose attributes field matches the filter are returned.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results the server should return.

  • view (String) (defaults to: nil) —

    View for VMware clusters. When BASIC is specified, only the cluster resource name and admin cluster membership are returned. The default/unset value CLUSTER_VIEW_UNSPECIFIED is the same as `FULL', which returns the complete cluster configuration details.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2640

def list_project_location_vmware_clusters(parent, allow_missing: nil, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/vmwareClusters', options)
  command.response_representation = Google::Apis::GkeonpremV1::ListVmwareClustersResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::ListVmwareClustersResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::ListLocationsResponse

Lists information about the supported locations for this service.

Parameters:

  • name (String) —

    The resource that owns the locations collection, if applicable.

  • extra_location_types (Array<String>, String) (defaults to: nil) —

    Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.

  • filter (String) (defaults to: nil) —

    A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of results to return. If not set, the service selects a default.

  • page_token (String) (defaults to: nil) —

    A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 117

def list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/locations', options)
  command.response_representation = Google::Apis::GkeonpremV1::ListLocationsResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::ListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['extraLocationTypes'] = extra_location_types unless extra_location_types.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_bare_metal_admin_cluster(name, bare_metal_admin_cluster_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Updates the parameters of a single bare metal admin cluster.

Parameters:

  • name (String) —

    Immutable. The bare metal admin cluster resource name.

  • bare_metal_admin_cluster_object (Google::Apis::GkeonpremV1::BareMetalAdminCluster) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. Field mask is used to specify the fields to be overwritten in the BareMetalAdminCluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all populated fields in the BareMetalAdminCluster message will be updated. Empty fields will be ignored unless a field mask is used.

  • validate_only (Boolean) (defaults to: nil) —

    Validate the request without actually doing any updates.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 386

def patch_project_location_bare_metal_admin_cluster(name, bare_metal_admin_cluster_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::GkeonpremV1::BareMetalAdminCluster::Representation
  command.request_object = bare_metal_admin_cluster_object
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_bare_metal_cluster(name, bare_metal_cluster_object = nil, allow_missing: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Updates the parameters of a single bare metal Cluster.

Parameters:

  • name (String) —

    Immutable. The bare metal user cluster resource name.

  • bare_metal_cluster_object (Google::Apis::GkeonpremV1::BareMetalCluster) (defaults to: nil)
  • allow_missing (Boolean) (defaults to: nil) —

    If set to true, and the bare metal cluster is not found, the request will create a new bare metal cluster with the provided configuration. The user must have both create and update permission to call Update with allow_missing set to true.

  • update_mask (String) (defaults to: nil) —

    Required. Field mask is used to specify the fields to be overwritten in the BareMetalCluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all populated fields in the BareMetalCluster message will be updated. Empty fields will be ignored unless a field mask is used.

  • validate_only (Boolean) (defaults to: nil) —

    Validate the request without actually doing any updates.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



961
962
963
964
965
966
967
968
969
970
971
972
973
974
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 961

def patch_project_location_bare_metal_cluster(name, bare_metal_cluster_object = nil, allow_missing: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::GkeonpremV1::BareMetalCluster::Representation
  command.request_object = bare_metal_cluster_object
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_bare_metal_cluster_bare_metal_node_pool(name, bare_metal_node_pool_object = nil, allow_missing: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Updates the parameters of a single bare metal node pool.

Parameters:

  • name (String) —

    Immutable. The bare metal node pool resource name.

  • bare_metal_node_pool_object (Google::Apis::GkeonpremV1::BareMetalNodePool) (defaults to: nil)
  • allow_missing (Boolean) (defaults to: nil) —

    If set to true, and the bare metal node pool is not found, the request will create a new bare metal node pool with the provided configuration. The user must have both create and update permission to call Update with allow_missing set to true.

  • update_mask (String) (defaults to: nil) —

    Required. Field mask is used to specify the fields to be overwritten in the BareMetalNodePool resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all populated fields in the BareMetalNodePool message will be updated. Empty fields will be ignored unless a field mask is used.

  • validate_only (Boolean) (defaults to: nil) —

    Validate the request without actually doing any updates.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1447

def patch_project_location_bare_metal_cluster_bare_metal_node_pool(name, bare_metal_node_pool_object = nil, allow_missing: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::GkeonpremV1::BareMetalNodePool::Representation
  command.request_object = bare_metal_node_pool_object
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_vmware_admin_cluster(name, vmware_admin_cluster_object = nil, skip_validations: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Updates the parameters of a single VMware admin cluster.

Parameters:

  • name (String) —

    Immutable. The VMware admin cluster resource name.

  • vmware_admin_cluster_object (Google::Apis::GkeonpremV1::VmwareAdminCluster) (defaults to: nil)
  • skip_validations (Array<String>, String) (defaults to: nil) —

    Optional. If set, the server-side preflight checks will be skipped.

  • update_mask (String) (defaults to: nil) —

    Required. Field mask is used to specify the fields to be overwritten in the VMwareAdminCluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all populated fields in the VmwareAdminCluster message will be updated. Empty fields will be ignored unless a field mask is used.

  • validate_only (Boolean) (defaults to: nil) —

    Validate the request without actually doing any updates.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2148

def patch_project_location_vmware_admin_cluster(name, vmware_admin_cluster_object = nil, skip_validations: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::GkeonpremV1::VmwareAdminCluster::Representation
  command.request_object = vmware_admin_cluster_object
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['skipValidations'] = skip_validations unless skip_validations.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_vmware_cluster(name, vmware_cluster_object = nil, skip_validations: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Updates the parameters of a single VMware cluster.

Parameters:

  • name (String) —

    Immutable. The VMware user cluster resource name.

  • vmware_cluster_object (Google::Apis::GkeonpremV1::VmwareCluster) (defaults to: nil)
  • skip_validations (Array<String>, String) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. Field mask is used to specify the fields to be overwritten in the VMwareCluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all populated fields in the VmwareCluster message will be updated. Empty fields will be ignored unless a field mask is used.

  • validate_only (Boolean) (defaults to: nil) —

    Validate the request without actually doing any updates.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2686

def patch_project_location_vmware_cluster(name, vmware_cluster_object = nil, skip_validations: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::GkeonpremV1::VmwareCluster::Representation
  command.request_object = vmware_cluster_object
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['skipValidations'] = skip_validations unless skip_validations.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_vmware_cluster_vmware_node_pool(name, vmware_node_pool_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Updates the parameters of a single VMware node pool.

Parameters:

  • name (String) —

    Immutable. The resource name of this node pool.

  • vmware_node_pool_object (Google::Apis::GkeonpremV1::VmwareNodePool) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. Field mask is used to specify the fields to be overwritten in the VMwareNodePool resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all populated fields in the VMwareNodePool message will be updated. Empty fields will be ignored unless a field mask is used.

  • validate_only (Boolean) (defaults to: nil) —

    Validate the request without actually doing any updates.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 3241

def patch_project_location_vmware_cluster_vmware_node_pool(name, vmware_node_pool_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::GkeonpremV1::VmwareNodePool::Representation
  command.request_object = vmware_node_pool_object
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#query_project_location_bare_metal_admin_cluster_version_config(parent, upgrade_config_cluster_name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::QueryBareMetalAdminVersionConfigResponse

Queries the bare metal admin cluster version config.

Parameters:

  • parent (String) —

    Required. The parent of the project and location to query for version config. Format: "projects/project/locations/location"

  • upgrade_config_cluster_name (String) (defaults to: nil) —

    The admin cluster resource name. This is the full resource name of the admin cluster resource. Format: "projects/project/locations/location/ bareMetalAdminClusters/bare_metal_admin_cluster"

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



425
426
427
428
429
430
431
432
433
434
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 425

def query_project_location_bare_metal_admin_cluster_version_config(parent, upgrade_config_cluster_name: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/bareMetalAdminClusters:queryVersionConfig', options)
  command.response_representation = Google::Apis::GkeonpremV1::QueryBareMetalAdminVersionConfigResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::QueryBareMetalAdminVersionConfigResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['upgradeConfig.clusterName'] = upgrade_config_cluster_name unless upgrade_config_cluster_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#query_project_location_bare_metal_cluster_version_config(parent, create_config_admin_cluster_membership: nil, create_config_admin_cluster_name: nil, upgrade_config_cluster_name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::QueryBareMetalVersionConfigResponse

Queries the bare metal user cluster version config.

Parameters:

  • parent (String) —

    Required. The parent of the project and location to query for version config. Format: "projects/project/locations/location"

  • create_config_admin_cluster_membership (String) (defaults to: nil) —

    The admin cluster membership. This is the full resource name of the admin cluster's fleet membership. Format: "projects/project/locations/location/ memberships/membership"

  • create_config_admin_cluster_name (String) (defaults to: nil) —

    The admin cluster resource name. This is the full resource name of the admin cluster resource. Format: "projects/project/locations/location/ bareMetalAdminClusters/bare_metal_admin_cluster"

  • upgrade_config_cluster_name (String) (defaults to: nil) —

    The user cluster resource name. This is the full resource name of the user cluster resource. Format: "projects/project/locations/location/ bareMetalClusters/bare_metal_cluster"

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1009

def query_project_location_bare_metal_cluster_version_config(parent, create_config_admin_cluster_membership: nil, create_config_admin_cluster_name: nil, upgrade_config_cluster_name: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/bareMetalClusters:queryVersionConfig', options)
  command.response_representation = Google::Apis::GkeonpremV1::QueryBareMetalVersionConfigResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::QueryBareMetalVersionConfigResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['createConfig.adminClusterMembership'] = create_config_admin_cluster_membership unless create_config_admin_cluster_membership.nil?
  command.query['createConfig.adminClusterName'] = create_config_admin_cluster_name unless create_config_admin_cluster_name.nil?
  command.query['upgradeConfig.clusterName'] = upgrade_config_cluster_name unless upgrade_config_cluster_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#query_project_location_vmware_cluster_version_config(parent, create_config_admin_cluster_membership: nil, create_config_admin_cluster_name: nil, upgrade_config_cluster_name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::QueryVmwareVersionConfigResponse

Queries the VMware user cluster version config.

Parameters:

  • parent (String) —

    Required. The parent of the project and location to query for version config. Format: "projects/project/locations/location"

  • create_config_admin_cluster_membership (String) (defaults to: nil) —

    The admin cluster membership. This is the full resource name of the admin cluster's fleet membership. Format: "projects/project/locations/location/ memberships/membership"

  • create_config_admin_cluster_name (String) (defaults to: nil) —

    The admin cluster resource name. This is the full resource name of the admin cluster resource. Format: "projects/project/locations/location/ vmwareAdminClusters/vmware_admin_cluster"

  • upgrade_config_cluster_name (String) (defaults to: nil) —

    The user cluster resource name. This is the full resource name of the user cluster resource. Format: "projects/project/locations/location/ vmwareClusters/vmware_cluster"

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2734

def query_project_location_vmware_cluster_version_config(parent, create_config_admin_cluster_membership: nil, create_config_admin_cluster_name: nil, upgrade_config_cluster_name: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/vmwareClusters:queryVersionConfig', options)
  command.response_representation = Google::Apis::GkeonpremV1::QueryVmwareVersionConfigResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::QueryVmwareVersionConfigResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['createConfig.adminClusterMembership'] = create_config_admin_cluster_membership unless create_config_admin_cluster_membership.nil?
  command.query['createConfig.adminClusterName'] = create_config_admin_cluster_name unless create_config_admin_cluster_name.nil?
  command.query['upgradeConfig.clusterName'] = upgrade_config_cluster_name unless upgrade_config_cluster_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_bare_metal_admin_cluster_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::GkeonpremV1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 461

def set_bare_metal_admin_cluster_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::GkeonpremV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::GkeonpremV1::Policy::Representation
  command.response_class = Google::Apis::GkeonpremV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_bare_metal_cluster_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::GkeonpremV1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1047

def set_bare_metal_cluster_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::GkeonpremV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::GkeonpremV1::Policy::Representation
  command.response_class = Google::Apis::GkeonpremV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_bare_metal_node_pool_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::GkeonpremV1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1487

def set_bare_metal_node_pool_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::GkeonpremV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::GkeonpremV1::Policy::Representation
  command.response_class = Google::Apis::GkeonpremV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_vmware_admin_cluster_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::GkeonpremV1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2188

def set_vmware_admin_cluster_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::GkeonpremV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::GkeonpremV1::Policy::Representation
  command.response_class = Google::Apis::GkeonpremV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_vmware_cluster_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::GkeonpremV1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2772

def set_vmware_cluster_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::GkeonpremV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::GkeonpremV1::Policy::Representation
  command.response_class = Google::Apis::GkeonpremV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_vmware_node_pool_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::GkeonpremV1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 3280

def set_vmware_node_pool_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::GkeonpremV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::GkeonpremV1::Policy::Representation
  command.response_class = Google::Apis::GkeonpremV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_bare_metal_admin_cluster_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::GkeonpremV1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 500

def test_bare_metal_admin_cluster_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::GkeonpremV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::GkeonpremV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_bare_metal_cluster_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::GkeonpremV1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1086

def test_bare_metal_cluster_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::GkeonpremV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::GkeonpremV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_bare_metal_node_pool_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::GkeonpremV1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1526

def test_bare_metal_node_pool_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::GkeonpremV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::GkeonpremV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_vmware_admin_cluster_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::GkeonpremV1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2227

def test_vmware_admin_cluster_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::GkeonpremV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::GkeonpremV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_vmware_cluster_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::GkeonpremV1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2811

def test_vmware_cluster_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::GkeonpremV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::GkeonpremV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_vmware_node_pool_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::GkeonpremV1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 3319

def test_vmware_node_pool_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::GkeonpremV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::GkeonpremV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::GkeonpremV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#unenroll_project_location_bare_metal_admin_cluster(name, allow_missing: nil, etag: nil, ignore_errors: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Unenrolls an existing bare metal admin cluster from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients.

Parameters:

  • name (String) —

    Required. Name of the bare metal admin cluster to be unenrolled. Format: " projects/project/locations/location/bareMetalAdminClusters/cluster"

  • allow_missing (Boolean) (defaults to: nil) —

    If set to true, and the bare metal admin cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.

  • etag (String) (defaults to: nil) —

    The current etag of the bare metal admin cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.

  • ignore_errors (Boolean) (defaults to: nil) —

    If set to true, the unenrollment of a bare metal admin cluster resource will succeed even if errors occur during unenrollment. This parameter can be used when you want to unenroll admin cluster resource and the on-prem admin cluster is disconnected / unreachable. WARNING: Using this parameter when your admin cluster still exists may result in a deleted GCP admin cluster but existing resourcelink in on-prem admin cluster and membership.

  • validate_only (Boolean) (defaults to: nil) —

    Validate the request without actually doing any updates.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 554

def unenroll_project_location_bare_metal_admin_cluster(name, allow_missing: nil, etag: nil, ignore_errors: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}:unenroll', options)
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['ignoreErrors'] = ignore_errors unless ignore_errors.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#unenroll_project_location_bare_metal_cluster(name, allow_missing: nil, etag: nil, force: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Unenrolls an existing bare metal user cluster and its node pools from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters and node pools will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients.

Parameters:

  • name (String) —

    Required. Name of the bare metal user cluster to be unenrolled. Format: " projects/project/locations/location/bareMetalClusters/cluster"

  • allow_missing (Boolean) (defaults to: nil) —

    If set to true, and the bare metal cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.

  • etag (String) (defaults to: nil) —

    The current etag of the bare metal Cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.

  • force (Boolean) (defaults to: nil) —

    This is required if the cluster has any associated node pools. When set, any child node pools will also be unenrolled.

  • validate_only (Boolean) (defaults to: nil) —

    Validate the request without actually doing any updates.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1135

def unenroll_project_location_bare_metal_cluster(name, allow_missing: nil, etag: nil, force: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}:unenroll', options)
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['force'] = force unless force.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#unenroll_project_location_bare_metal_cluster_bare_metal_node_pool(name, allow_missing: nil, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Unenrolls a bare metal node pool from Anthos On-Prem API.

Parameters:

  • name (String) —

    Required. The name of the node pool to unenroll. Format: projects/project/ locations/location/bareMetalClusters/cluster/bareMetalNodePools/nodepool

  • allow_missing (Boolean) (defaults to: nil) —

    If set to true, and the bare metal node pool is not found, the request will succeed but no action will be taken on the server and return a completed LRO.

  • etag (String) (defaults to: nil) —

    The current etag of the bare metal node pool. If an etag is provided and does not match the current etag of node pool, deletion will be blocked and an ABORTED error will be returned.

  • validate_only (Boolean) (defaults to: nil) —

    If set, only validate the request, but do not actually unenroll the node pool.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 1568

def unenroll_project_location_bare_metal_cluster_bare_metal_node_pool(name, allow_missing: nil, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}:unenroll', options)
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#unenroll_project_location_vmware_admin_cluster(name, allow_missing: nil, etag: nil, ignore_errors: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Unenrolls an existing VMware admin cluster from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients.

Parameters:

  • name (String) —

    Required. Name of the VMware admin cluster to be unenrolled. Format: "projects/ project/locations/location/vmwareAdminClusters/cluster"

  • allow_missing (Boolean) (defaults to: nil) —

    If set to true, and the VMware admin cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.

  • etag (String) (defaults to: nil) —

    The current etag of the VMware admin cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.

  • ignore_errors (Boolean) (defaults to: nil) —

    Optional. If set to true, the unenrollment of a vmware admin cluster resource will succeed even if errors occur during unenrollment. This parameter can be used when you want to unenroll admin cluster resource and the on-prem admin cluster is disconnected / unreachable. WARNING: Using this parameter when your admin cluster still exists may result in a deleted GCP admin cluster but existing resourcelink in on-prem admin cluster and membership.

  • validate_only (Boolean) (defaults to: nil) —

    Validate the request without actually doing any updates.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2280

def unenroll_project_location_vmware_admin_cluster(name, allow_missing: nil, etag: nil, ignore_errors: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}:unenroll', options)
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['ignoreErrors'] = ignore_errors unless ignore_errors.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#unenroll_project_location_vmware_cluster(name, allow_missing: nil, etag: nil, force: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Unenrolls an existing VMware user cluster and its node pools from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters and node pools will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or UI.

Parameters:

  • name (String) —

    Required. Name of the VMware user cluster to be unenrolled. Format: "projects/ project/locations/location/vmwareClusters/vmware_cluster"

  • allow_missing (Boolean) (defaults to: nil) —

    If set to true, and the VMware cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.

  • etag (String) (defaults to: nil) —

    The current etag of the VMware Cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.

  • force (Boolean) (defaults to: nil) —

    This is required if the cluster has any associated node pools. When set, any child node pools will also be unenrolled.

  • validate_only (Boolean) (defaults to: nil) —

    Validate the request without actually doing any updates.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 2860

def unenroll_project_location_vmware_cluster(name, allow_missing: nil, etag: nil, force: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}:unenroll', options)
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['force'] = force unless force.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#unenroll_project_location_vmware_cluster_vmware_node_pool(name, allow_missing: nil, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkeonpremV1::Operation

Unenrolls a VMware node pool to Anthos On-Prem API

Parameters:

  • name (String) —

    Required. The name of the node pool to unenroll. Format: projects/project/ locations/location/vmwareClusters/cluster/vmwareNodePools/nodepool

  • allow_missing (Boolean) (defaults to: nil) —

    If set to true, and the VMware node pool is not found, the request will succeed but no action will be taken on the server and return a completed LRO.

  • etag (String) (defaults to: nil) —

    The current etag of the VMware node pool. If an etag is provided and does not match the current etag of node pool, deletion will be blocked and an ABORTED error will be returned.

  • validate_only (Boolean) (defaults to: nil) —

    If set, only validate the request, but do not actually unenroll the node pool.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
 
# File 'lib/google/apis/gkeonprem_v1/service.rb', line 3361

def unenroll_project_location_vmware_cluster_vmware_node_pool(name, allow_missing: nil, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}:unenroll', options)
  command.response_representation = Google::Apis::GkeonpremV1::Operation::Representation
  command.response_class = Google::Apis::GkeonpremV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end