Class: Google::Apis::GkehubV2alpha::GKEHubService

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

Overview

GKE Hub API

Examples:

require 'google/apis/gkehub_v2alpha'

Gkehub = Google::Apis::GkehubV2alpha # Alias the module
service = Gkehub::GKEHubService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeGKEHubService

Returns a new instance of GKEHubService.



45
46
47
48
49
50
# File 'lib/google/apis/gkehub_v2alpha/service.rb', line 45

def initialize
  super('https://gkehub.googleapis.com/', '',
        client_name: 'google-apis-gkehub_v2alpha',
        client_version: Google::Apis::GkehubV2alpha::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

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.



38
39
40
# File 'lib/google/apis/gkehub_v2alpha/service.rb', line 38

def key
  @key
end

#quota_userString

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.



43
44
45
# File 'lib/google/apis/gkehub_v2alpha/service.rb', line 43

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::GkehubV2alpha::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::GkehubV2alpha::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



504
505
506
507
508
509
510
511
512
513
514
# File 'lib/google/apis/gkehub_v2alpha/service.rb', line 504

def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+name}:cancel', options)
  command.request_representation = Google::Apis::GkehubV2alpha::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  command.response_representation = Google::Apis::GkehubV2alpha::Empty::Representation
  command.response_class = Google::Apis::GkehubV2alpha::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_feature_config(parent, feature_config_object = nil, feature_config_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkehubV2alpha::Operation

Creates FeatureConfig under a given parent.

Parameters:

  • parent (String)

    Required. The name of parent where the FeatureConfig will be created. Specified in the format projects/project/locations/global/featureConfigs/ feature_type/feature_config/.

  • feature_config_object (Google::Apis::GkehubV2alpha::FeatureConfig) (defaults to: nil)
  • feature_config_id (String) (defaults to: nil)

    The ID of the feature config to create.

  • request_id (String) (defaults to: nil)

    Idempotent request UUID.

  • 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



152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/google/apis/gkehub_v2alpha/service.rb', line 152

def create_project_location_feature_config(parent, feature_config_object = nil, feature_config_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/featureConfigs', options)
  command.request_representation = Google::Apis::GkehubV2alpha::FeatureConfig::Representation
  command.request_object = feature_config_object
  command.response_representation = Google::Apis::GkehubV2alpha::Operation::Representation
  command.response_class = Google::Apis::GkehubV2alpha::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['featureConfigId'] = feature_config_id unless feature_config_id.nil?
  command.query['requestId'] = request_id unless request_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_membership_feature(parent, membership_feature_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkehubV2alpha::Operation

Creates membershipFeature under a given parent.

Parameters:

  • parent (String)

    Required. The name of parent where the MembershipFeature will be created. Specified in the format projects/*/locations/*/memberships/*/features/*.

  • membership_feature_object (Google::Apis::GkehubV2alpha::MembershipFeature) (defaults to: nil)
  • request_id (String) (defaults to: nil)

    Idempotent request UUID.

  • 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



303
304
305
306
307
308
309
310
311
312
313
314
# File 'lib/google/apis/gkehub_v2alpha/service.rb', line 303

def create_project_location_membership_feature(parent, membership_feature_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/features', options)
  command.request_representation = Google::Apis::GkehubV2alpha::MembershipFeature::Representation
  command.request_object = membership_feature_object
  command.response_representation = Google::Apis::GkehubV2alpha::Operation::Representation
  command.response_class = Google::Apis::GkehubV2alpha::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['requestId'] = request_id unless request_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_feature_config(name, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkehubV2alpha::Operation

Removes a FeatureConfig.

Parameters:

  • name (String)

    Required. The name of the membershipFeature to be deleted. Specified in the format projects/*/locations/*/featureConfigs/**.

  • request_id (String) (defaults to: nil)

    Idempotent request UUID.

  • 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



189
190
191
192
193
194
195
196
197
198
# File 'lib/google/apis/gkehub_v2alpha/service.rb', line 189

def delete_project_location_feature_config(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::GkehubV2alpha::Operation::Representation
  command.response_class = Google::Apis::GkehubV2alpha::Operation
  command.params['name'] = name unless name.nil?
  command.query['requestId'] = request_id unless request_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_membership_feature(name, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkehubV2alpha::Operation

Removes a membershipFeature.

Parameters:

  • name (String)

    Required. The name of the membershipFeature to be deleted. Specified in the format projects/*/locations/*/memberships/*/features/*.

  • request_id (String) (defaults to: nil)

    Idempotent request UUID.

  • 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



339
340
341
342
343
344
345
346
347
348
# File 'lib/google/apis/gkehub_v2alpha/service.rb', line 339

def delete_project_location_membership_feature(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::GkehubV2alpha::Operation::Representation
  command.response_class = Google::Apis::GkehubV2alpha::Operation
  command.params['name'] = name unless name.nil?
  command.query['requestId'] = request_id unless request_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

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkehubV2alpha::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



72
73
74
75
76
77
78
79
80
# File 'lib/google/apis/gkehub_v2alpha/service.rb', line 72

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::GkehubV2alpha::Location::Representation
  command.response_class = Google::Apis::GkehubV2alpha::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_feature_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkehubV2alpha::FeatureConfig

========= FeatureConfig Services ========= Gets details of a featureConfig.

Parameters:

  • name (String)

    Required. The FeatureConfig resource name in the format projects/*/locations/* /featureConfigs/**.

  • 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



221
222
223
224
225
226
227
228
229
# File 'lib/google/apis/gkehub_v2alpha/service.rb', line 221

def get_project_location_feature_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::GkehubV2alpha::FeatureConfig::Representation
  command.response_class = Google::Apis::GkehubV2alpha::FeatureConfig
  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_membership_feature(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkehubV2alpha::MembershipFeature

========= MembershipFeature Services ========= Gets details of a membershipFeature.

Parameters:

  • name (String)

    Required. The MembershipFeature resource name in the format projects/*/ locations/*/memberships/*/features/*.

  • 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



372
373
374
375
376
377
378
379
380
# File 'lib/google/apis/gkehub_v2alpha/service.rb', line 372

def get_project_location_membership_feature(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::GkehubV2alpha::MembershipFeature::Representation
  command.response_class = Google::Apis::GkehubV2alpha::MembershipFeature
  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::GkehubV2alpha::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



537
538
539
540
541
542
543
544
545
# File 'lib/google/apis/gkehub_v2alpha/service.rb', line 537

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::GkehubV2alpha::Operation::Representation
  command.response_class = Google::Apis::GkehubV2alpha::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_feature_configs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkehubV2alpha::ListFeatureConfigsResponse

Lists all FeatureConfigs in a given project and location.

Parameters:

  • parent (String)

    Required. The parent where the FeatureConfigs will be listed. In the format: projects/*/locations/*.

  • filter (String) (defaults to: nil)

    Lists FeatureConfigs that match the filter expression, following the syntax outlined in https://google.aip.dev/160.

  • order_by (String) (defaults to: nil)

    One or more fields to compare and use to sort the output. See https://google. aip.dev/132#ordering.

  • page_size (Fixnum) (defaults to: nil)

    When requesting a 'page' of resources, page_size specifies number of resources to return. If unspecified or set to 0, all resources will be returned.

  • page_token (String) (defaults to: nil)

    Token returned by previous call to ListFeatures which specifies the position in the list from where to continue listing the resources.

  • 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



265
266
267
268
269
270
271
272
273
274
275
276
277
# File 'lib/google/apis/gkehub_v2alpha/service.rb', line 265

def list_project_location_feature_configs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+parent}/featureConfigs', options)
  command.response_representation = Google::Apis::GkehubV2alpha::ListFeatureConfigsResponse::Representation
  command.response_class = Google::Apis::GkehubV2alpha::ListFeatureConfigsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.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

#list_project_location_membership_features(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkehubV2alpha::ListMembershipFeaturesResponse

Lists MembershipFeatures in a given project and location.

Parameters:

  • parent (String)

    Required. The parent where the MembershipFeature will be listed. In the format: projects/*/locations/*/memberships/*.

  • filter (String) (defaults to: nil)

    Lists MembershipFeatures that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: - Feature with the name "helloworld" in project "foo-proj" and membership "member-bar": name = " projects/foo-proj/locations/global/memberships/member-bar/features/helloworld"

    • Features that have a label called foo: labels.foo:* - Features that have a label called foo whose value is bar: labels.foo = bar
  • order_by (String) (defaults to: nil)

    One or more fields to compare and use to sort the output. See https://google. aip.dev/132#ordering.

  • page_size (Fixnum) (defaults to: nil)

    When requesting a 'page' of resources, page_size specifies number of resources to return. If unspecified or set to 0, all resources will be returned.

  • page_token (String) (defaults to: nil)

    Token returned by previous call to ListFeatures which specifies the position in the list from where to continue listing the resources.

  • 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



420
421
422
423
424
425
426
427
428
429
430
431
432
# File 'lib/google/apis/gkehub_v2alpha/service.rb', line 420

def list_project_location_membership_features(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+parent}/features', options)
  command.response_representation = Google::Apis::GkehubV2alpha::ListMembershipFeaturesResponse::Representation
  command.response_class = Google::Apis::GkehubV2alpha::ListMembershipFeaturesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.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

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

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

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.

  • 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



580
581
582
583
584
585
586
587
588
589
590
591
# File 'lib/google/apis/gkehub_v2alpha/service.rb', line 580

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}/operations', options)
  command.response_representation = Google::Apis::GkehubV2alpha::ListOperationsResponse::Representation
  command.response_class = Google::Apis::GkehubV2alpha::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['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, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkehubV2alpha::ListLocationsResponse

Lists information about the supported locations for this service.

Parameters:

  • name (String)

    The resource that owns the locations collection, if applicable.

  • 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



112
113
114
115
116
117
118
119
120
121
122
123
# File 'lib/google/apis/gkehub_v2alpha/service.rb', line 112

def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}/locations', options)
  command.response_representation = Google::Apis::GkehubV2alpha::ListLocationsResponse::Representation
  command.response_class = Google::Apis::GkehubV2alpha::ListLocationsResponse
  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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_membership_feature(name, membership_feature_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkehubV2alpha::Operation

Updates an existing MembershipFeature.

Parameters:

  • name (String)

    Output only. The resource name of the membershipFeature, in the format: projects/project/locations/location/memberships/membership/features/ feature`. Note thatmembershipFeaturesis shortened tofeatures` in the resource name. (see http://go/aip/122#collection-identifiers)

  • membership_feature_object (Google::Apis::GkehubV2alpha::MembershipFeature) (defaults to: nil)
  • request_id (String) (defaults to: nil)

    Idempotent request UUID.

  • update_mask (String) (defaults to: nil)

    Required. Mask of fields to update.

  • 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



462
463
464
465
466
467
468
469
470
471
472
473
474
# File 'lib/google/apis/gkehub_v2alpha/service.rb', line 462

def patch_project_location_membership_feature(name, membership_feature_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha/{+name}', options)
  command.request_representation = Google::Apis::GkehubV2alpha::MembershipFeature::Representation
  command.request_object = membership_feature_object
  command.response_representation = Google::Apis::GkehubV2alpha::Operation::Representation
  command.response_class = Google::Apis::GkehubV2alpha::Operation
  command.params['name'] = name unless name.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end