Class: Google::Apis::GkehubV2alpha::GKEHubService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::GkehubV2alpha::GKEHubService
- Defined in:
- lib/google/apis/gkehub_v2alpha/service.rb
Overview
GKE Hub API
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GkehubV2alpha::Location
Gets information about a location.
-
#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.
-
#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.
-
#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.
-
#initialize ⇒ GKEHubService
constructor
A new instance of GKEHubService.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
Constructor Details
#initialize ⇒ GKEHubService
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
#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.
38 39 40 |
# File 'lib/google/apis/gkehub_v2alpha/service.rb', line 38 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.
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.
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', ) 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.
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', ) 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.
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', ) 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.
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}', ) 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.
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}', ) 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.
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}', ) 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.
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}', ) 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.
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}', ) 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.
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}', ) 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.
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', ) 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.
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', ) 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.
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', ) 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.
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', ) 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.
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}', ) 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 |