Class: Google::Apis::RunV2::CloudRunService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::RunV2::CloudRunService
- Defined in:
- lib/google/apis/run_v2/service.rb
Overview
Cloud Run Admin API
Deploy and manage user provided container images that scale automatically based on incoming requests. The Cloud Run Admin API v1 follows the Knative Serving API specification, while v2 is aligned with Google Cloud AIP-based API standards, as described in https://google.aip.dev/.
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
-
#create_project_location_service(parent, google_cloud_run_op_v2_service_object = nil, service_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleLongrunningOperation
Creates a new Service in a given project and location.
-
#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleProtobufEmpty
Deletes a long-running operation.
-
#delete_project_location_service(name, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleLongrunningOperation
Deletes a Service.
-
#delete_project_location_service_revision(name, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleLongrunningOperation
Delete a Revision.
-
#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleLongrunningOperation
Gets the latest state of a long-running operation.
-
#get_project_location_service(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleCloudRunOpV2Service
Gets information about a Service.
-
#get_project_location_service_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleIamV1Policy
Get the IAM Access Control policy currently in effect for the given Cloud Run Service.
-
#get_project_location_service_revision(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleCloudRunOpV2Revision
Gets information about a Revision.
-
#initialize ⇒ CloudRunService
constructor
A new instance of CloudRunService.
-
#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleLongrunningListOperationsResponse
Lists operations that match the specified filter in the request.
-
#list_project_location_service_revisions(parent, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleCloudRunOpV2ListRevisionsResponse
List Revisions from a given Service, or from a given location.
-
#list_project_location_services(parent, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleCloudRunOpV2ListServicesResponse
List Services.
-
#patch_project_location_service(name, google_cloud_run_op_v2_service_object = nil, allow_missing: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleLongrunningOperation
Updates a Service.
-
#set_project_location_service_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleIamV1Policy
Sets the IAM Access control policy for the specified Service.
-
#test_project_location_service_iam_permissions(resource, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleIamV1TestIamPermissionsResponse
Returns permissions that a caller has on the specified Project.
Constructor Details
#initialize ⇒ CloudRunService
Returns a new instance of CloudRunService.
48 49 50 51 52 53 |
# File 'lib/google/apis/run_v2/service.rb', line 48 def initialize super('https://run.googleapis.com/', '', client_name: 'google-apis-run_v2', client_version: Google::Apis::RunV2::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.
41 42 43 |
# File 'lib/google/apis/run_v2/service.rb', line 41 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.
46 47 48 |
# File 'lib/google/apis/run_v2/service.rb', line 46 def quota_user @quota_user end |
Instance Method Details
#create_project_location_service(parent, google_cloud_run_op_v2_service_object = nil, service_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleLongrunningOperation
Creates a new Service in a given project and location.
199 200 201 202 203 204 205 206 207 208 209 210 211 |
# File 'lib/google/apis/run_v2/service.rb', line 199 def create_project_location_service(parent, google_cloud_run_op_v2_service_object = nil, service_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+parent}/services', ) command.request_representation = Google::Apis::RunV2::GoogleCloudRunOpV2Service::Representation command.request_object = google_cloud_run_op_v2_service_object command.response_representation = Google::Apis::RunV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RunV2::GoogleLongrunningOperation command.params['parent'] = parent unless parent.nil? command.query['serviceId'] = service_id unless service_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 |
#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleProtobufEmpty
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.
78 79 80 81 82 83 84 85 86 |
# File 'lib/google/apis/run_v2/service.rb', line 78 def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2/{+name}', ) command.response_representation = Google::Apis::RunV2::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::RunV2::GoogleProtobufEmpty 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_service(name, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleLongrunningOperation
Deletes a Service. This will cause the Service to stop serving traffic and will delete all revisions.
241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/google/apis/run_v2/service.rb', line 241 def delete_project_location_service(name, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2/{+name}', ) command.response_representation = Google::Apis::RunV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RunV2::GoogleLongrunningOperation command.params['name'] = name unless name.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 |
#delete_project_location_service_revision(name, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleLongrunningOperation
Delete a Revision.
514 515 516 517 518 519 520 521 522 523 524 |
# File 'lib/google/apis/run_v2/service.rb', line 514 def delete_project_location_service_revision(name, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2/{+name}', ) command.response_representation = Google::Apis::RunV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RunV2::GoogleLongrunningOperation command.params['name'] = name unless name.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 |
#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleLongrunningOperation
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.
109 110 111 112 113 114 115 116 117 |
# File 'lib/google/apis/run_v2/service.rb', line 109 def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) command.response_representation = Google::Apis::RunV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RunV2::GoogleLongrunningOperation 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_service(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleCloudRunOpV2Service
Gets information about a Service.
274 275 276 277 278 279 280 281 282 |
# File 'lib/google/apis/run_v2/service.rb', line 274 def get_project_location_service(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) command.response_representation = Google::Apis::RunV2::GoogleCloudRunOpV2Service::Representation command.response_class = Google::Apis::RunV2::GoogleCloudRunOpV2Service 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_service_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleIamV1Policy
Get the IAM Access Control policy currently in effect for the given Cloud Run Service. This result does not include any inherited policies.
317 318 319 320 321 322 323 324 325 326 |
# File 'lib/google/apis/run_v2/service.rb', line 317 def get_project_location_service_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+resource}:getIamPolicy', ) command.response_representation = Google::Apis::RunV2::GoogleIamV1Policy::Representation command.response_class = Google::Apis::RunV2::GoogleIamV1Policy command.params['resource'] = resource unless resource.nil? command.query['options.requestedPolicyVersion'] = unless .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_service_revision(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleCloudRunOpV2Revision
Gets information about a Revision.
547 548 549 550 551 552 553 554 555 |
# File 'lib/google/apis/run_v2/service.rb', line 547 def get_project_location_service_revision(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) command.response_representation = Google::Apis::RunV2::GoogleCloudRunOpV2Revision::Representation command.response_class = Google::Apis::RunV2::GoogleCloudRunOpV2Revision 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_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleLongrunningListOperationsResponse
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.
158 159 160 161 162 163 164 165 166 167 168 169 |
# File 'lib/google/apis/run_v2/service.rb', line 158 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, 'v2/{+name}/operations', ) command.response_representation = Google::Apis::RunV2::GoogleLongrunningListOperationsResponse::Representation command.response_class = Google::Apis::RunV2::GoogleLongrunningListOperationsResponse 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_location_service_revisions(parent, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleCloudRunOpV2ListRevisionsResponse
List Revisions from a given Service, or from a given location.
586 587 588 589 590 591 592 593 594 595 596 597 |
# File 'lib/google/apis/run_v2/service.rb', line 586 def list_project_location_service_revisions(parent, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+parent}/revisions', ) command.response_representation = Google::Apis::RunV2::GoogleCloudRunOpV2ListRevisionsResponse::Representation command.response_class = Google::Apis::RunV2::GoogleCloudRunOpV2ListRevisionsResponse 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['showDeleted'] = show_deleted unless show_deleted.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_services(parent, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleCloudRunOpV2ListServicesResponse
List Services.
356 357 358 359 360 361 362 363 364 365 366 367 |
# File 'lib/google/apis/run_v2/service.rb', line 356 def list_project_location_services(parent, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+parent}/services', ) command.response_representation = Google::Apis::RunV2::GoogleCloudRunOpV2ListServicesResponse::Representation command.response_class = Google::Apis::RunV2::GoogleCloudRunOpV2ListServicesResponse 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['showDeleted'] = show_deleted unless show_deleted.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_service(name, google_cloud_run_op_v2_service_object = nil, allow_missing: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleLongrunningOperation
Updates a Service.
402 403 404 405 406 407 408 409 410 411 412 413 414 415 |
# File 'lib/google/apis/run_v2/service.rb', line 402 def patch_project_location_service(name, google_cloud_run_op_v2_service_object = nil, allow_missing: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2/{+name}', ) command.request_representation = Google::Apis::RunV2::GoogleCloudRunOpV2Service::Representation command.request_object = google_cloud_run_op_v2_service_object command.response_representation = Google::Apis::RunV2::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RunV2::GoogleLongrunningOperation 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 |
#set_project_location_service_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleIamV1Policy
Sets the IAM Access control policy for the specified Service. Overwrites any existing policy.
440 441 442 443 444 445 446 447 448 449 450 |
# File 'lib/google/apis/run_v2/service.rb', line 440 def set_project_location_service_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+resource}:setIamPolicy', ) command.request_representation = Google::Apis::RunV2::GoogleIamV1SetIamPolicyRequest::Representation command.request_object = google_iam_v1_set_iam_policy_request_object command.response_representation = Google::Apis::RunV2::GoogleIamV1Policy::Representation command.response_class = Google::Apis::RunV2::GoogleIamV1Policy 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_project_location_service_iam_permissions(resource, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleIamV1TestIamPermissionsResponse
Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.
475 476 477 478 479 480 481 482 483 484 485 |
# File 'lib/google/apis/run_v2/service.rb', line 475 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::RunV2::GoogleIamV1TestIamPermissionsRequest::Representation command.request_object = command.response_representation = Google::Apis::RunV2::GoogleIamV1TestIamPermissionsResponse::Representation command.response_class = Google::Apis::RunV2::GoogleIamV1TestIamPermissionsResponse 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 |