Class: Google::Apis::RunV1alpha1::CloudRunService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/run_v1alpha1/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_v1alpha1'

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

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CloudRunService

Returns a new instance of CloudRunService.



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

def initialize
  super('https://run.googleapis.com/', '',
        client_name: 'google-apis-run_v1alpha1',
        client_version: Google::Apis::RunV1alpha1::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.



41
42
43
 
# File 'lib/google/apis/run_v1alpha1/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.

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.



46
47
48
 
# File 'lib/google/apis/run_v1alpha1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#create_namespace_job(parent, job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1alpha1::Job

Create a job.

Parameters:

  • parent (String) —

    Required. The namespace in which the job should be created. Replace namespace_id with the project ID or number.

  • job_object (Google::Apis::RunV1alpha1::Job) (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



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/google/apis/run_v1alpha1/service.rb', line 77

def create_namespace_job(parent, job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'apis/run.googleapis.com/v1alpha1/{+parent}/jobs', options)
  command.request_representation = Google::Apis::RunV1alpha1::Job::Representation
  command.request_object = job_object
  command.response_representation = Google::Apis::RunV1alpha1::Job::Representation
  command.response_class = Google::Apis::RunV1alpha1::Job
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_namespace_job(name, api_version: nil, kind: nil, propagation_policy: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1alpha1::Empty

Delete a job.

Parameters:

  • name (String) —

    Required. The name of the job to delete. For Cloud Run (fully managed), replace namespace_id with the project ID or number.

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

    Optional. Cloud Run currently ignores this parameter.

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

    Optional. Cloud Run currently ignores this parameter.

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

    Optional. Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/ docs/concepts/workloads/controllers/garbage-collection/ for more information.

  • 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



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

def delete_namespace_job(name, api_version: nil, kind: nil, propagation_policy: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'apis/run.googleapis.com/v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::RunV1alpha1::Empty::Representation
  command.response_class = Google::Apis::RunV1alpha1::Empty
  command.params['name'] = name unless name.nil?
  command.query['apiVersion'] = api_version unless api_version.nil?
  command.query['kind'] = kind unless kind.nil?
  command.query['propagationPolicy'] = propagation_policy unless propagation_policy.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_namespace_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1alpha1::Job

Get information about a job.

Parameters:

  • name (String) —

    Required. The name of the job to retrieve. For Cloud Run (fully managed), replace namespace_id with the 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



152
153
154
155
156
157
158
159
160
 
# File 'lib/google/apis/run_v1alpha1/service.rb', line 152

def get_namespace_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apis/run.googleapis.com/v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::RunV1alpha1::Job::Representation
  command.response_class = Google::Apis::RunV1alpha1::Job
  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_namespace_jobs(parent, continue: nil, field_selector: nil, include_uninitialized: nil, label_selector: nil, limit: nil, resource_version: nil, watch: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1alpha1::ListJobsResponse

List jobs.

Parameters:

  • parent (String) —

    Required. The namespace from which the jobs should be listed. Replace namespace_id with the project ID or number.

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

    Optional. Optional encoded string to continue paging.

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

    Optional. Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.

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

    Optional. Not currently used by Cloud Run.

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

    Optional. Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn.

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

    Optional. The maximum number of records that should be returned.

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

    Optional. The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.

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

    Optional. Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.

  • 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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/google/apis/run_v1alpha1/service.rb', line 202

def list_namespace_jobs(parent, continue: nil, field_selector: nil, include_uninitialized: nil, label_selector: nil, limit: nil, resource_version: nil, watch: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apis/run.googleapis.com/v1alpha1/{+parent}/jobs', options)
  command.response_representation = Google::Apis::RunV1alpha1::ListJobsResponse::Representation
  command.response_class = Google::Apis::RunV1alpha1::ListJobsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['continue'] = continue unless continue.nil?
  command.query['fieldSelector'] = field_selector unless field_selector.nil?
  command.query['includeUninitialized'] = include_uninitialized unless include_uninitialized.nil?
  command.query['labelSelector'] = label_selector unless label_selector.nil?
  command.query['limit'] = limit unless limit.nil?
  command.query['resourceVersion'] = resource_version unless resource_version.nil?
  command.query['watch'] = watch unless watch.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end