Class: Google::Apis::RunV1beta1::CloudRunService

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

Overview

Cloud Run Admin API

Deploy and manage user provided container images that scale automatically based on HTTP traffic.

Examples:

require 'google/apis/run_v1beta1'

Run = Google::Apis::RunV1beta1 # 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.



46
47
48
49
 
# File 'generated/google/apis/run_v1beta1/service.rb', line 46

def initialize
  super('https://run.googleapis.com/', '')
  @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.



39
40
41
 
# File 'generated/google/apis/run_v1beta1/service.rb', line 39

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.



44
45
46
 
# File 'generated/google/apis/run_v1beta1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#get_namespace_customresourcedefinition(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1beta1::CustomResourceDefinition

Rpc to get information about a CustomResourceDefinition.

Parameters:

  • name (String) —

    The name of the CustomResourceDefinition being retrieved. If needed, replace namespace_id with the project ID.

  • 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
 
# File 'generated/google/apis/run_v1beta1/service.rb', line 127

def get_namespace_customresourcedefinition(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apis/apiextensions.k8s.io/v1beta1/{+name}', options)
  command.response_representation = Google::Apis::RunV1beta1::CustomResourceDefinition::Representation
  command.response_class = Google::Apis::RunV1beta1::CustomResourceDefinition
  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_customresourcedefinition(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1beta1::CustomResourceDefinition

Rpc to get information about a CustomResourceDefinition.

Parameters:

  • name (String) —

    The name of the CustomResourceDefinition being retrieved. If needed, replace namespace_id with the project ID.

  • 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



158
159
160
161
162
163
164
165
166
 
# File 'generated/google/apis/run_v1beta1/service.rb', line 158

def get_project_location_customresourcedefinition(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::RunV1beta1::CustomResourceDefinition::Representation
  command.response_class = Google::Apis::RunV1beta1::CustomResourceDefinition
  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_customresourcedefinitions(continue: nil, field_selector: nil, include_uninitialized: nil, label_selector: nil, limit: nil, parent: nil, resource_version: nil, watch: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1beta1::ListCustomResourceDefinitionsResponse

Rpc to list custom resource definitions.

Parameters:

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

    Optional encoded string to continue paging.

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

    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) —

    Not currently used by Cloud Run.

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

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

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

    The project ID or project number from which the storages should be listed.

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

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

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

    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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'generated/google/apis/run_v1beta1/service.rb', line 89

def list_customresourcedefinitions(continue: nil, field_selector: nil, include_uninitialized: nil, label_selector: nil, limit: nil, parent: nil, resource_version: nil, watch: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions', options)
  command.response_representation = Google::Apis::RunV1beta1::ListCustomResourceDefinitionsResponse::Representation
  command.response_class = Google::Apis::RunV1beta1::ListCustomResourceDefinitionsResponse
  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['parent'] = parent unless parent.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

#list_project_location_customresourcedefinitions(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::RunV1beta1::ListCustomResourceDefinitionsResponse

Rpc to list custom resource definitions.

Parameters:

  • parent (String) —

    The project ID or project number from which the storages should be listed.

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

    Optional encoded string to continue paging.

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

    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) —

    Not currently used by Cloud Run.

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

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

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

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

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

    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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'generated/google/apis/run_v1beta1/service.rb', line 206

def list_project_location_customresourcedefinitions(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, 'v1beta1/{+parent}/customresourcedefinitions', options)
  command.response_representation = Google::Apis::RunV1beta1::ListCustomResourceDefinitionsResponse::Representation
  command.response_class = Google::Apis::RunV1beta1::ListCustomResourceDefinitionsResponse
  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