Class: Google::Apis::RunV2::CloudRunService

Inherits:
Core::BaseService
  • Object
show all
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/.

Examples:

require 'google/apis/run_v2'

Run = Google::Apis::RunV2 # Alias the module
service = Run::CloudRunService.new

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CloudRunService

Returns a new instance of CloudRunService.



50
51
52
53
54
55
 
# File 'lib/google/apis/run_v2/service.rb', line 50

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        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.

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.



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

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.



48
49
50
 
# File 'lib/google/apis/run_v2/service.rb', line 48

def quota_user
  @quota_user
end

Instance Method Details

#cancel_project_location_job_execution(name, google_cloud_run_v2_cancel_execution_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleLongrunningOperation

Cancels an Execution.

Parameters:

  • name (String) —

    Required. The name of the Execution to cancel. Format: projects/project/ locations/location/jobs/job/executions/execution, whereproject`` can be project id or number.

  • google_cloud_run_v2_cancel_execution_request_object (Google::Apis::RunV2::GoogleCloudRunV2CancelExecutionRequest) (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



428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/google/apis/run_v2/service.rb', line 428

def cancel_project_location_job_execution(name, google_cloud_run_v2_cancel_execution_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:cancel', options)
  command.request_representation = Google::Apis::RunV2::GoogleCloudRunV2CancelExecutionRequest::Representation
  command.request_object = google_cloud_run_v2_cancel_execution_request_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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_job(parent, google_cloud_run_v2_job_object = nil, job_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleLongrunningOperation

Creates a Job.

Parameters:

  • parent (String) —

    Required. The location and project in which this Job should be created. Format: projects/project/locations/location, where project can be project id or number.

  • google_cloud_run_v2_job_object (Google::Apis::RunV2::GoogleCloudRunV2Job) (defaults to: nil)
  • job_id (String) (defaults to: nil) —

    Required. The unique identifier for the Job. The name of the job becomes parent/jobs/job_id.

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

    Indicates that the request should be validated and default values populated, without persisting the request or creating any 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



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/google/apis/run_v2/service.rb', line 86

def create_project_location_job(parent, google_cloud_run_v2_job_object = nil, job_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/jobs', options)
  command.request_representation = Google::Apis::RunV2::GoogleCloudRunV2Job::Representation
  command.request_object = google_cloud_run_v2_job_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['jobId'] = job_id unless job_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_service(parent, google_cloud_run_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.

Parameters:

  • parent (String) —

    Required. The location and project in which this service should be created. Format: projects/project/locations/location, where project can be project id or number. Only lowercase characters, digits, and hyphens.

  • google_cloud_run_v2_service_object (Google::Apis::RunV2::GoogleCloudRunV2Service) (defaults to: nil)
  • service_id (String) (defaults to: nil) —

    Required. The unique identifier for the Service. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the service becomes parent/services/service_id.

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

    Indicates that the request should be validated and default values populated, without persisting the request or creating any 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



809
810
811
812
813
814
815
816
817
818
819
820
821
 
# File 'lib/google/apis/run_v2/service.rb', line 809

def create_project_location_service(parent, google_cloud_run_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', options)
  command.request_representation = Google::Apis::RunV2::GoogleCloudRunV2Service::Representation
  command.request_object = google_cloud_run_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_job(name, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleLongrunningOperation

Deletes a Job.

Parameters:

  • name (String) —

    Required. The full name of the Job. Format: projects/project/locations/ location/jobs/job, where project can be project id or number.

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

    A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

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

    Indicates that the request should be validated without actually deleting any 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



127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/google/apis/run_v2/service.rb', line 127

def delete_project_location_job(name, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+name}', options)
  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_job_execution(name, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleLongrunningOperation

Deletes an Execution.

Parameters:

  • name (String) —

    Required. The name of the Execution to delete. Format: projects/project/ locations/location/jobs/job/executions/execution, whereproject`` can be project id or number.

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

    A system-generated fingerprint for this version of the resource. This may be used to detect modification conflict during updates.

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

    Indicates that the request should be validated without actually deleting any 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



468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/google/apis/run_v2/service.rb', line 468

def delete_project_location_job_execution(name, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+name}', options)
  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_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.

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



652
653
654
655
656
657
658
659
660
 
# File 'lib/google/apis/run_v2/service.rb', line 652

def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+name}', options)
  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.

Parameters:

  • name (String) —

    Required. The full name of the Service. Format: projects/project/locations/ location/services/service, where project can be project id or number.

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

    A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

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

    Indicates that the request should be validated without actually deleting any 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



851
852
853
854
855
856
857
858
859
860
861
 
# File 'lib/google/apis/run_v2/service.rb', line 851

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}', options)
  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

Deletes a Revision.

Parameters:

  • name (String) —

    Required. The name of the Revision to delete. Format: projects/project/ locations/location/services/service/revisions/revision

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

    A system-generated fingerprint for this version of the resource. This may be used to detect modification conflict during updates.

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

    Indicates that the request should be validated without actually deleting any 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



1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
 
# File 'lib/google/apis/run_v2/service.rb', line 1125

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}', options)
  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_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleCloudRunV2Job

Gets information about a Job.

Parameters:

  • name (String) —

    Required. The full name of the Job. Format: projects/project/locations/ location/jobs/job, where project can be project id or number.

  • 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



160
161
162
163
164
165
166
167
168
 
# File 'lib/google/apis/run_v2/service.rb', line 160

def get_project_location_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::RunV2::GoogleCloudRunV2Job::Representation
  command.response_class = Google::Apis::RunV2::GoogleCloudRunV2Job
  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_job_execution(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleCloudRunV2Execution

Gets information about an Execution.

Parameters:

  • name (String) —

    Required. The full name of the Execution. Format: projects/project/ locations/location/jobs/job/executions/execution, whereproject`` can be project id or number.

  • 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



502
503
504
505
506
507
508
509
510
 
# File 'lib/google/apis/run_v2/service.rb', line 502

def get_project_location_job_execution(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::RunV2::GoogleCloudRunV2Execution::Representation
  command.response_class = Google::Apis::RunV2::GoogleCloudRunV2Execution
  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_job_execution_task(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleCloudRunV2Task

Gets information about a Task.

Parameters:

  • name (String) —

    Required. The full name of the Task. Format: projects/project/locations/ location/jobs/job/executions/execution/tasks/task

  • 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



576
577
578
579
580
581
582
583
584
 
# File 'lib/google/apis/run_v2/service.rb', line 576

def get_project_location_job_execution_task(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::RunV2::GoogleCloudRunV2Task::Representation
  command.response_class = Google::Apis::RunV2::GoogleCloudRunV2Task
  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_job_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleIamV1Policy

Gets the IAM Access Control policy currently in effect for the given Job. This result does not include any inherited policies.

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



204
205
206
207
208
209
210
211
212
213
 
# File 'lib/google/apis/run_v2/service.rb', line 204

def get_project_location_job_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+resource}:getIamPolicy', options)
  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'] = 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_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.

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



683
684
685
686
687
688
689
690
691
 
# File 'lib/google/apis/run_v2/service.rb', line 683

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  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::GoogleCloudRunV2Service

Gets information about a Service.

Parameters:

  • name (String) —

    Required. The full name of the Service. Format: projects/project/locations/ location/services/service, where project can be project id or number.

  • 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



884
885
886
887
888
889
890
891
892
 
# File 'lib/google/apis/run_v2/service.rb', line 884

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

Gets the IAM Access Control policy currently in effect for the given Cloud Run Service. This result does not include any inherited policies.

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



928
929
930
931
932
933
934
935
936
937
 
# File 'lib/google/apis/run_v2/service.rb', line 928

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', options)
  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'] = 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_service_revision(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleCloudRunV2Revision

Gets information about a Revision.

Parameters:

  • name (String) —

    Required. The full name of the Revision. Format: projects/project/locations/ location/services/service/revisions/revision

  • 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



1158
1159
1160
1161
1162
1163
1164
1165
1166
 
# File 'lib/google/apis/run_v2/service.rb', line 1158

def get_project_location_service_revision(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::RunV2::GoogleCloudRunV2Revision::Representation
  command.response_class = Google::Apis::RunV2::GoogleCloudRunV2Revision
  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_job_execution_tasks(parent, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleCloudRunV2ListTasksResponse

Lists Tasks from an Execution of a Job.

Parameters:

  • parent (String) —

    Required. The Execution from which the Tasks should be listed. To list all Tasks across Executions of a Job, use "-" instead of Execution name. To list all Tasks across Jobs, use "-" instead of Job name. Format: projects/project/ locations/location/jobs/job/executions/execution

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

    Maximum number of Tasks to return in this call.

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

    A page token received from a previous call to ListTasks. All other parameters must match.

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

    If true, returns deleted (but unexpired) resources along with active ones.

  • 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



616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'lib/google/apis/run_v2/service.rb', line 616

def list_project_location_job_execution_tasks(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}/tasks', options)
  command.response_representation = Google::Apis::RunV2::GoogleCloudRunV2ListTasksResponse::Representation
  command.response_class = Google::Apis::RunV2::GoogleCloudRunV2ListTasksResponse
  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_job_executions(parent, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleCloudRunV2ListExecutionsResponse

Lists Executions from a Job.

Parameters:

  • parent (String) —

    Required. The Execution from which the Executions should be listed. To list all Executions across Jobs, use "-" instead of Job name. Format: projects/ project/locations/location/jobs/job, whereproject`` can be project id or number.

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

    Maximum number of Executions to return in this call.

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

    A page token received from a previous call to ListExecutions. All other parameters must match.

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

    If true, returns deleted (but unexpired) resources along with active ones.

  • 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



542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/google/apis/run_v2/service.rb', line 542

def list_project_location_job_executions(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}/executions', options)
  command.response_representation = Google::Apis::RunV2::GoogleCloudRunV2ListExecutionsResponse::Representation
  command.response_class = Google::Apis::RunV2::GoogleCloudRunV2ListExecutionsResponse
  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_jobs(parent, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleCloudRunV2ListJobsResponse

Lists Jobs.

Parameters:

  • parent (String) —

    Required. The location and project to list resources on. Format: projects/ project/locations/location, where project can be project id or number.

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

    Maximum number of Jobs to return in this call.

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

    A page token received from a previous call to ListJobs. All other parameters must match.

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

    If true, returns deleted (but unexpired) resources along with active ones.

  • 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



243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/google/apis/run_v2/service.rb', line 243

def list_project_location_jobs(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}/jobs', options)
  command.response_representation = Google::Apis::RunV2::GoogleCloudRunV2ListJobsResponse::Representation
  command.response_class = Google::Apis::RunV2::GoogleCloudRunV2ListJobsResponse
  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_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.

Parameters:

  • name (String) —

    Required. To query for all of the operations for a project.

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

    Optional. A filter for matching the completed or in-progress operations. The supported formats of filter are: To query for only completed operations: done:true To query for only ongoing operations: done:false Must be empty to query for all of the latest operations for the given parent project.

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

    The maximum number of records that should be returned. Requested page size cannot exceed 100. If not set or set to less than or equal to 0, the default page size is 100. .

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

    Token identifying which result to start with, which is returned by a previous list call.

  • 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



726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'lib/google/apis/run_v2/service.rb', line 726

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', options)
  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::GoogleCloudRunV2ListRevisionsResponse

Lists Revisions from a given Service, or from a given location.

Parameters:

  • parent (String) —

    Required. The Service from which the Revisions should be listed. To list all Revisions across Services, use "-" instead of Service name. Format: projects/ project/locations/location/services/service

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

    Maximum number of revisions to return in this call.

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

    A page token received from a previous call to ListRevisions. All other parameters must match.

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

    If true, returns deleted (but unexpired) resources along with active ones.

  • 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



1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
 
# File 'lib/google/apis/run_v2/service.rb', line 1197

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', options)
  command.response_representation = Google::Apis::RunV2::GoogleCloudRunV2ListRevisionsResponse::Representation
  command.response_class = Google::Apis::RunV2::GoogleCloudRunV2ListRevisionsResponse
  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::GoogleCloudRunV2ListServicesResponse

Lists Services.

Parameters:

  • parent (String) —

    Required. The location and project to list resources on. Location must be a valid Google Cloud region, and cannot be the "-" wildcard. Format: projects/ project/locations/location, where project can be project id or number.

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

    Maximum number of Services to return in this call.

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

    A page token received from a previous call to ListServices. All other parameters must match.

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

    If true, returns deleted (but unexpired) resources along with active ones.

  • 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



968
969
970
971
972
973
974
975
976
977
978
979
 
# File 'lib/google/apis/run_v2/service.rb', line 968

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', options)
  command.response_representation = Google::Apis::RunV2::GoogleCloudRunV2ListServicesResponse::Representation
  command.response_class = Google::Apis::RunV2::GoogleCloudRunV2ListServicesResponse
  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_job(name, google_cloud_run_v2_job_object = nil, allow_missing: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleLongrunningOperation

Updates a Job.

Parameters:

  • name (String) —

    The fully qualified name of this Job. Format: projects/project/locations/ location/jobs/job

  • google_cloud_run_v2_job_object (Google::Apis::RunV2::GoogleCloudRunV2Job) (defaults to: nil)
  • allow_missing (Boolean) (defaults to: nil) —

    If set to true, and if the Job does not exist, it will create a new one. Caller must have both create and update permissions for this call if this is set to true.

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

    Indicates that the request should be validated and default values populated, without persisting the request or updating any 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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/google/apis/run_v2/service.rb', line 285

def patch_project_location_job(name, google_cloud_run_v2_job_object = nil, allow_missing: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::RunV2::GoogleCloudRunV2Job::Representation
  command.request_object = google_cloud_run_v2_job_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['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_service(name, google_cloud_run_v2_service_object = nil, allow_missing: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleLongrunningOperation

Updates a Service.

Parameters:

  • name (String) —

    The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/project/locations/ location/services/service_id

  • google_cloud_run_v2_service_object (Google::Apis::RunV2::GoogleCloudRunV2Service) (defaults to: nil)
  • allow_missing (Boolean) (defaults to: nil) —

    If set to true, and if the Service does not exist, it will create a new one. The caller must have 'run.services.create' permissions if this is set to true and the Service does not exist.

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

    Indicates that the request should be validated and default values populated, without persisting the request or updating any 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



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
 
# File 'lib/google/apis/run_v2/service.rb', line 1012

def patch_project_location_service(name, google_cloud_run_v2_service_object = nil, allow_missing: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::RunV2::GoogleCloudRunV2Service::Representation
  command.request_object = google_cloud_run_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['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

#run_project_location_job(name, google_cloud_run_v2_run_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleLongrunningOperation

Triggers creation of a new Execution of this Job.

Parameters:

  • name (String) —

    Required. The full name of the Job. Format: projects/project/locations/ location/jobs/job, where project can be project id or number.

  • google_cloud_run_v2_run_job_request_object (Google::Apis::RunV2::GoogleCloudRunV2RunJobRequest) (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



321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/google/apis/run_v2/service.rb', line 321

def run_project_location_job(name, google_cloud_run_v2_run_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:run', options)
  command.request_representation = Google::Apis::RunV2::GoogleCloudRunV2RunJobRequest::Representation
  command.request_object = google_cloud_run_v2_run_job_request_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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_location_job_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 Job. Overwrites any existing policy.

Parameters:

  • resource (String) —

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

  • google_iam_v1_set_iam_policy_request_object (Google::Apis::RunV2::GoogleIamV1SetIamPolicyRequest) (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



357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/google/apis/run_v2/service.rb', line 357

def set_project_location_job_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', options)
  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

#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.

Parameters:

  • resource (String) —

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

  • google_iam_v1_set_iam_policy_request_object (Google::Apis::RunV2::GoogleIamV1SetIamPolicyRequest) (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



1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
 
# File 'lib/google/apis/run_v2/service.rb', line 1050

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', options)
  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_job_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.

Parameters:

  • resource (String) —

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

  • google_iam_v1_test_iam_permissions_request_object (Google::Apis::RunV2::GoogleIamV1TestIamPermissionsRequest) (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



393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/google/apis/run_v2/service.rb', line 393

def test_project_location_job_iam_permissions(resource, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::RunV2::GoogleIamV1TestIamPermissionsRequest::Representation
  command.request_object = google_iam_v1_test_iam_permissions_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

#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.

Parameters:

  • resource (String) —

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

  • google_iam_v1_test_iam_permissions_request_object (Google::Apis::RunV2::GoogleIamV1TestIamPermissionsRequest) (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/run_v2/service.rb', line 1086

def test_project_location_service_iam_permissions(resource, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::RunV2::GoogleIamV1TestIamPermissionsRequest::Representation
  command.request_object = google_iam_v1_test_iam_permissions_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

#wait_project_location_operation(name, google_longrunning_wait_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV2::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String) —

    The name of the operation resource to wait on.

  • google_longrunning_wait_operation_request_object (Google::Apis::RunV2::GoogleLongrunningWaitOperationRequest) (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



767
768
769
770
771
772
773
774
775
776
777
 
# File 'lib/google/apis/run_v2/service.rb', line 767

def wait_project_location_operation(name, google_longrunning_wait_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:wait', options)
  command.request_representation = Google::Apis::RunV2::GoogleLongrunningWaitOperationRequest::Representation
  command.request_object = google_longrunning_wait_operation_request_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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end