Class: Google::Apis::RunV1::CloudRunService

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

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

#initializeCloudRunService

Returns a new instance of CloudRunService.



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

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-run_v1',
        client_version: Google::Apis::RunV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

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_v1/service.rb', line 43

def key
  @key
end

#quota_userString

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_v1/service.rb', line 48

def quota_user
  @quota_user
end

Instance Method Details

#cancel_execution(name, cancel_execution_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Execution

Cancel an execution.

Parameters:

  • name (String)

    Required. The name of the execution to cancel. Replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/PROJECT_ID

  • cancel_execution_request_object (Google::Apis::RunV1::CancelExecutionRequest) (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



376
377
378
379
380
381
382
383
384
385
386
# File 'lib/google/apis/run_v1/service.rb', line 376

def cancel_execution(name, cancel_execution_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'apis/run.googleapis.com/v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::RunV1::CancelExecutionRequest::Representation
  command.request_object = cancel_execution_request_object
  command.response_representation = Google::Apis::RunV1::Execution::Representation
  command.response_class = Google::Apis::RunV1::Execution
  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_namespace_domainmapping(parent, domain_mapping_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::DomainMapping

Create a new domain mapping.

Parameters:

  • parent (String)

    Required. The namespace in which the domain mapping should be created. For Cloud Run (fully managed), replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/PROJECT_ID

  • domain_mapping_object (Google::Apis::RunV1::DomainMapping) (defaults to: nil)
  • dry_run (String) (defaults to: nil)

    Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

  • 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



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

def create_namespace_domainmapping(parent, domain_mapping_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'apis/domains.cloudrun.com/v1/{+parent}/domainmappings', options)
  command.request_representation = Google::Apis::RunV1::DomainMapping::Representation
  command.request_object = domain_mapping_object
  command.response_representation = Google::Apis::RunV1::DomainMapping::Representation
  command.response_class = Google::Apis::RunV1::DomainMapping
  command.params['parent'] = parent unless parent.nil?
  command.query['dryRun'] = dry_run unless dry_run.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_namespace_instance(parent, instance_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Instance

Create a Instance.

Parameters:

  • parent (String)

    Required. The namespace in which the Instance should be created. Replace namespace with the project ID or number. It takes the form namespaces/ namespace. For example: namespaces/PROJECT_ID

  • instance_object (Google::Apis::RunV1::Instance) (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



539
540
541
542
543
544
545
546
547
548
549
# File 'lib/google/apis/run_v1/service.rb', line 539

def create_namespace_instance(parent, instance_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'apis/run.googleapis.com/v1/{+parent}/instances', options)
  command.request_representation = Google::Apis::RunV1::Instance::Representation
  command.request_object = instance_object
  command.response_representation = Google::Apis::RunV1::Instance::Representation
  command.response_class = Google::Apis::RunV1::Instance
  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

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

Create a job.

Parameters:

  • parent (String)

    Required. The namespace in which the job should be created. Replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/PROJECT_ID

  • job_object (Google::Apis::RunV1::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



808
809
810
811
812
813
814
815
816
817
818
# File 'lib/google/apis/run_v1/service.rb', line 808

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/v1/{+parent}/jobs', options)
  command.request_representation = Google::Apis::RunV1::Job::Representation
  command.request_object = job_object
  command.response_representation = Google::Apis::RunV1::Job::Representation
  command.response_class = Google::Apis::RunV1::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

#create_namespace_service(parent, service_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Service

Creates a new Service. Service creation will trigger a new deployment. Use GetService, and check service.status to determine if the Service is ready.

Parameters:

  • parent (String)

    Required. The resource's parent. In Cloud Run, it may be one of the following:

    • project_id_or_number * namespaces/project_id_or_number* `namespaces/ `project_id_or_number`/services` * `projects/`project_id_or_number`/locations/` region * projects/project_id_or_number/regions/region``
  • service_object (Google::Apis::RunV1::Service) (defaults to: nil)
  • dry_run (String) (defaults to: nil)

    Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

  • 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



1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
# File 'lib/google/apis/run_v1/service.rb', line 1276

def create_namespace_service(parent, service_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'apis/serving.knative.dev/v1/{+parent}/services', options)
  command.request_representation = Google::Apis::RunV1::Service::Representation
  command.request_object = service_object
  command.response_representation = Google::Apis::RunV1::Service::Representation
  command.response_class = Google::Apis::RunV1::Service
  command.params['parent'] = parent unless parent.nil?
  command.query['dryRun'] = dry_run unless dry_run.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_namespace_workerpool(parent, worker_pool_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::WorkerPool

Creates a new WorkerPool. WorkerPool creation will trigger a new deployment. Use GetWorkerPool, and check worker_pool.status to determine if the WorkerPool is ready.

Parameters:

  • parent (String)

    Required. The resource's parent. In Cloud Run, it may be one of the following:

    • project_id_or_number * namespaces/project_id_or_number* `namespaces/ `project_id_or_number`/workerpools` * `projects/`project_id_or_number`/ locations/`region * projects/project_id_or_number/regions/region``
  • worker_pool_object (Google::Apis::RunV1::WorkerPool) (defaults to: nil)
  • dry_run (String) (defaults to: nil)

    Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

  • 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



1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
# File 'lib/google/apis/run_v1/service.rb', line 1597

def create_namespace_workerpool(parent, worker_pool_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'apis/run.googleapis.com/v1/{+parent}/workerpools', options)
  command.request_representation = Google::Apis::RunV1::WorkerPool::Representation
  command.request_object = worker_pool_object
  command.response_representation = Google::Apis::RunV1::WorkerPool::Representation
  command.response_class = Google::Apis::RunV1::WorkerPool
  command.params['parent'] = parent unless parent.nil?
  command.query['dryRun'] = dry_run unless dry_run.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_domainmapping(parent, domain_mapping_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::DomainMapping

Create a new domain mapping.

Parameters:

  • parent (String)

    Required. The namespace in which the domain mapping should be created. For Cloud Run (fully managed), replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/PROJECT_ID

  • domain_mapping_object (Google::Apis::RunV1::DomainMapping) (defaults to: nil)
  • dry_run (String) (defaults to: nil)

    Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

  • 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



2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
# File 'lib/google/apis/run_v1/service.rb', line 2012

def create_project_location_domainmapping(parent, domain_mapping_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/domainmappings', options)
  command.request_representation = Google::Apis::RunV1::DomainMapping::Representation
  command.request_object = domain_mapping_object
  command.response_representation = Google::Apis::RunV1::DomainMapping::Representation
  command.response_class = Google::Apis::RunV1::DomainMapping
  command.params['parent'] = parent unless parent.nil?
  command.query['dryRun'] = dry_run unless dry_run.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, service_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Service

Creates a new Service. Service creation will trigger a new deployment. Use GetService, and check service.status to determine if the Service is ready.

Parameters:

  • parent (String)

    Required. The resource's parent. In Cloud Run, it may be one of the following:

    • project_id_or_number * namespaces/project_id_or_number* `namespaces/ `project_id_or_number`/services` * `projects/`project_id_or_number`/locations/` region * projects/project_id_or_number/regions/region``
  • service_object (Google::Apis::RunV1::Service) (defaults to: nil)
  • dry_run (String) (defaults to: nil)

    Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

  • 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



2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
# File 'lib/google/apis/run_v1/service.rb', line 2809

def create_project_location_service(parent, service_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/services', options)
  command.request_representation = Google::Apis::RunV1::Service::Representation
  command.request_object = service_object
  command.response_representation = Google::Apis::RunV1::Service::Representation
  command.response_class = Google::Apis::RunV1::Service
  command.params['parent'] = parent unless parent.nil?
  command.query['dryRun'] = dry_run unless dry_run.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_domainmapping(name, api_version: nil, dry_run: nil, kind: nil, propagation_policy: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Status

Delete a domain mapping.

Parameters:

  • name (String)

    Required. The name of the domain mapping to delete. For Cloud Run (fully managed), replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/PROJECT_ID

  • api_version (String) (defaults to: nil)

    Cloud Run currently ignores this parameter.

  • dry_run (String) (defaults to: nil)

    Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

  • kind (String) (defaults to: nil)

    Cloud Run currently ignores this parameter.

  • propagation_policy (String) (defaults to: nil)

    Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/ architecture/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



249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'lib/google/apis/run_v1/service.rb', line 249

def delete_namespace_domainmapping(name, api_version: nil, dry_run: nil, kind: nil, propagation_policy: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'apis/domains.cloudrun.com/v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Status::Representation
  command.response_class = Google::Apis::RunV1::Status
  command.params['name'] = name unless name.nil?
  command.query['apiVersion'] = api_version unless api_version.nil?
  command.query['dryRun'] = dry_run unless dry_run.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

#delete_namespace_execution(name, api_version: nil, kind: nil, propagation_policy: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Status

Delete an execution.

Parameters:

  • name (String)

    Required. The name of the execution to delete. Replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/PROJECT_ID

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

  • 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



417
418
419
420
421
422
423
424
425
426
427
428
# File 'lib/google/apis/run_v1/service.rb', line 417

def delete_namespace_execution(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/v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Status::Representation
  command.response_class = Google::Apis::RunV1::Status
  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

#delete_namespace_instance(name, api_version: nil, kind: nil, propagation_policy: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Status

Delete a Instance.

Parameters:

  • name (String)

    Required. The name of the Instance to delete. Replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/PROJECT_ID

  • 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



581
582
583
584
585
586
587
588
589
590
591
592
# File 'lib/google/apis/run_v1/service.rb', line 581

def delete_namespace_instance(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/v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Status::Representation
  command.response_class = Google::Apis::RunV1::Status
  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

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

Delete a job.

Parameters:

  • name (String)

    Required. The name of the job to delete. Replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/PROJECT_ID

  • 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



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

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/v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Status::Representation
  command.response_class = Google::Apis::RunV1::Status
  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

#delete_namespace_revision(name, api_version: nil, dry_run: nil, kind: nil, propagation_policy: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Status

Delete a revision.

Parameters:

  • name (String)

    The name of the revision to delete. For Cloud Run (fully managed), replace namespace with the project ID or number. It takes the form namespaces/ namespace. For example: namespaces/PROJECT_ID

  • api_version (String) (defaults to: nil)

    Cloud Run currently ignores this parameter.

  • dry_run (String) (defaults to: nil)

    Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

  • kind (String) (defaults to: nil)

    Cloud Run currently ignores this parameter.

  • propagation_policy (String) (defaults to: nil)

    Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background.

  • 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



1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
# File 'lib/google/apis/run_v1/service.rb', line 1054

def delete_namespace_revision(name, api_version: nil, dry_run: nil, kind: nil, propagation_policy: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'apis/serving.knative.dev/v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Status::Representation
  command.response_class = Google::Apis::RunV1::Status
  command.params['name'] = name unless name.nil?
  command.query['apiVersion'] = api_version unless api_version.nil?
  command.query['dryRun'] = dry_run unless dry_run.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

#delete_namespace_service(name, api_version: nil, dry_run: nil, kind: nil, propagation_policy: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Status

Deletes the provided service. This will cause the Service to stop serving traffic and will delete all associated Revisions.

Parameters:

  • name (String)

    Required. The fully qualified name of the service to delete. It can be any of the following forms: * namespaces/project_id_or_number/services/ service_name(only when the `endpoint` is regional) * `projects/` project_id_or_number`/locations/`region`/services/`service_name * projects/ project_id_or_number/regions/region/services/service_name``

  • api_version (String) (defaults to: nil)

    Not supported, and ignored by Cloud Run.

  • dry_run (String) (defaults to: nil)

    Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

  • kind (String) (defaults to: nil)

    Not supported, and ignored by Cloud Run.

  • propagation_policy (String) (defaults to: nil)

    Not supported, and ignored 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



1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
# File 'lib/google/apis/run_v1/service.rb', line 1323

def delete_namespace_service(name, api_version: nil, dry_run: nil, kind: nil, propagation_policy: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'apis/serving.knative.dev/v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Status::Representation
  command.response_class = Google::Apis::RunV1::Status
  command.params['name'] = name unless name.nil?
  command.query['apiVersion'] = api_version unless api_version.nil?
  command.query['dryRun'] = dry_run unless dry_run.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

#delete_namespace_workerpool(name, dry_run: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Status

Deletes the provided worker pool. This will cause the WorkerPool to stop all instances and will delete all associated WorkerPoolRevisions.

Parameters:

  • name (String)

    Required. The fully qualified name of the worker pool to delete. It can be any of the following forms: * namespaces/project_id_or_number/workerpools/ worker_pool_name(only when the `endpoint` is regional) * `projects/` project_id_or_number`/locations/`region`/workerpools/`worker_pool_name * projects/project_id_or_number/regions/region/workerpools/worker_pool_name

  • dry_run (String) (defaults to: nil)

    Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

  • 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



1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
# File 'lib/google/apis/run_v1/service.rb', line 1639

def delete_namespace_workerpool(name, dry_run: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'apis/run.googleapis.com/v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Status::Representation
  command.response_class = Google::Apis::RunV1::Status
  command.params['name'] = name unless name.nil?
  command.query['dryRun'] = dry_run unless dry_run.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_domainmapping(name, api_version: nil, dry_run: nil, kind: nil, propagation_policy: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Status

Delete a domain mapping.

Parameters:

  • name (String)

    Required. The name of the domain mapping to delete. For Cloud Run (fully managed), replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/PROJECT_ID

  • api_version (String) (defaults to: nil)

    Cloud Run currently ignores this parameter.

  • dry_run (String) (defaults to: nil)

    Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

  • kind (String) (defaults to: nil)

    Cloud Run currently ignores this parameter.

  • propagation_policy (String) (defaults to: nil)

    Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/ architecture/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



2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
# File 'lib/google/apis/run_v1/service.rb', line 2058

def delete_project_location_domainmapping(name, api_version: nil, dry_run: nil, kind: nil, propagation_policy: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Status::Representation
  command.response_class = Google::Apis::RunV1::Status
  command.params['name'] = name unless name.nil?
  command.query['apiVersion'] = api_version unless api_version.nil?
  command.query['dryRun'] = dry_run unless dry_run.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

#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Empty

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



2419
2420
2421
2422
2423
2424
2425
2426
2427
# File 'lib/google/apis/run_v1/service.rb', line 2419

def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Empty::Representation
  command.response_class = Google::Apis::RunV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_revision(name, api_version: nil, dry_run: nil, kind: nil, propagation_policy: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Status

Delete a revision.

Parameters:

  • name (String)

    The name of the revision to delete. For Cloud Run (fully managed), replace namespace with the project ID or number. It takes the form namespaces/ namespace. For example: namespaces/PROJECT_ID

  • api_version (String) (defaults to: nil)

    Cloud Run currently ignores this parameter.

  • dry_run (String) (defaults to: nil)

    Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

  • kind (String) (defaults to: nil)

    Cloud Run currently ignores this parameter.

  • propagation_policy (String) (defaults to: nil)

    Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background.

  • 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



2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
# File 'lib/google/apis/run_v1/service.rb', line 2587

def delete_project_location_revision(name, api_version: nil, dry_run: nil, kind: nil, propagation_policy: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Status::Representation
  command.response_class = Google::Apis::RunV1::Status
  command.params['name'] = name unless name.nil?
  command.query['apiVersion'] = api_version unless api_version.nil?
  command.query['dryRun'] = dry_run unless dry_run.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

#delete_project_location_service(name, api_version: nil, dry_run: nil, kind: nil, propagation_policy: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Status

Deletes the provided service. This will cause the Service to stop serving traffic and will delete all associated Revisions.

Parameters:

  • name (String)

    Required. The fully qualified name of the service to delete. It can be any of the following forms: * namespaces/project_id_or_number/services/ service_name(only when the `endpoint` is regional) * `projects/` project_id_or_number`/locations/`region`/services/`service_name * projects/ project_id_or_number/regions/region/services/service_name``

  • api_version (String) (defaults to: nil)

    Not supported, and ignored by Cloud Run.

  • dry_run (String) (defaults to: nil)

    Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

  • kind (String) (defaults to: nil)

    Not supported, and ignored by Cloud Run.

  • propagation_policy (String) (defaults to: nil)

    Not supported, and ignored 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



2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
# File 'lib/google/apis/run_v1/service.rb', line 2856

def delete_project_location_service(name, api_version: nil, dry_run: nil, kind: nil, propagation_policy: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Status::Representation
  command.response_class = Google::Apis::RunV1::Status
  command.params['name'] = name unless name.nil?
  command.query['apiVersion'] = api_version unless api_version.nil?
  command.query['dryRun'] = dry_run unless dry_run.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_configuration(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Configuration

Get information about a configuration.

Parameters:

  • name (String)

    The name of the configuration to retrieve. For Cloud Run, 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



114
115
116
117
118
119
120
121
122
# File 'lib/google/apis/run_v1/service.rb', line 114

def get_namespace_configuration(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apis/serving.knative.dev/v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Configuration::Representation
  command.response_class = Google::Apis::RunV1::Configuration
  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_namespace_domainmapping(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::DomainMapping

Get information about a domain mapping.

Parameters:

  • name (String)

    Required. The name of the domain mapping to retrieve. For Cloud Run (fully managed), replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/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



285
286
287
288
289
290
291
292
293
# File 'lib/google/apis/run_v1/service.rb', line 285

def get_namespace_domainmapping(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apis/domains.cloudrun.com/v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::DomainMapping::Representation
  command.response_class = Google::Apis::RunV1::DomainMapping
  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_namespace_execution(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Execution

Get information about an execution.

Parameters:

  • name (String)

    Required. The name of the execution to retrieve. Replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/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



452
453
454
455
456
457
458
459
460
# File 'lib/google/apis/run_v1/service.rb', line 452

def get_namespace_execution(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apis/run.googleapis.com/v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Execution::Representation
  command.response_class = Google::Apis::RunV1::Execution
  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_namespace_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Instance

Get an Instance.

Parameters:

  • name (String)

    Required. The name of the Instance to retrieve. It takes the form namespaces/ namespace/instances/Instance_name and the endpoint must be regional. Replace namespace 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



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

def get_namespace_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apis/run.googleapis.com/v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Instance::Representation
  command.response_class = Google::Apis::RunV1::Instance
  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_namespace_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Job

Get information about a job.

Parameters:

  • name (String)

    Required. The name of the job to retrieve. It takes the form namespaces/ namespace/jobs/job_name and the endpoint must be regional. Replace namespace 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



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

def get_namespace_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apis/run.googleapis.com/v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Job::Representation
  command.response_class = Google::Apis::RunV1::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

#get_namespace_revision(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Revision

Get information about a revision.

Parameters:

  • name (String)

    The name of the revision to retrieve. For Cloud Run (fully managed), replace namespace with the project ID or number. It takes the form namespaces/ namespace. For example: namespaces/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



1090
1091
1092
1093
1094
1095
1096
1097
1098
# File 'lib/google/apis/run_v1/service.rb', line 1090

def get_namespace_revision(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apis/serving.knative.dev/v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Revision::Representation
  command.response_class = Google::Apis::RunV1::Revision
  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_namespace_route(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Route

Get information about a route.

Parameters:

  • name (String)

    The name of the route to retrieve. For Cloud Run (fully managed), replace namespace with the project ID or number. It takes the form namespaces/ namespace. For example: namespaces/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



1180
1181
1182
1183
1184
1185
1186
1187
1188
# File 'lib/google/apis/run_v1/service.rb', line 1180

def get_namespace_route(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apis/serving.knative.dev/v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Route::Representation
  command.response_class = Google::Apis::RunV1::Route
  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_namespace_service(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Service

Gets information about a service.

Parameters:

  • name (String)

    Required. The fully qualified name of the service to retrieve. It can be any of the following forms: * namespaces/project_id_or_number/services/ service_name(only when the `endpoint` is regional) * `projects/` project_id_or_number`/locations/`region`/services/`service_name * projects/ project_id_or_number/regions/region/services/service_name``

  • 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



1361
1362
1363
1364
1365
1366
1367
1368
1369
# File 'lib/google/apis/run_v1/service.rb', line 1361

def get_namespace_service(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apis/serving.knative.dev/v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Service::Representation
  command.response_class = Google::Apis::RunV1::Service
  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_namespace_task(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Task

Get information about a task.

Parameters:

  • name (String)

    Required. The name of the task to retrieve. Replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/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



1494
1495
1496
1497
1498
1499
1500
1501
1502
# File 'lib/google/apis/run_v1/service.rb', line 1494

def get_namespace_task(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apis/run.googleapis.com/v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Task::Representation
  command.response_class = Google::Apis::RunV1::Task
  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_namespace_workerpool(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::WorkerPool

Gets information about a worker pool.

Parameters:

  • name (String)

    Required. The fully qualified name of the worker pool to retrieve. It can be any of the following forms: * namespaces/project_id_or_number/workerpools/ worker_pool_name(only when the `endpoint` is regional) * `projects/` project_id_or_number`/locations/`region`/workerpools/`worker_pool_name * projects/project_id_or_number/regions/region/workerpools/worker_pool_name

  • 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



1675
1676
1677
1678
1679
1680
1681
1682
1683
# File 'lib/google/apis/run_v1/service.rb', line 1675

def get_namespace_workerpool(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apis/run.googleapis.com/v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::WorkerPool::Representation
  command.response_class = Google::Apis::RunV1::WorkerPool
  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_configuration(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Configuration

Get information about a configuration.

Parameters:

  • name (String)

    The name of the configuration to retrieve. For Cloud Run, 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



1923
1924
1925
1926
1927
1928
1929
1930
1931
# File 'lib/google/apis/run_v1/service.rb', line 1923

def get_project_location_configuration(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Configuration::Representation
  command.response_class = Google::Apis::RunV1::Configuration
  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_domainmapping(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::DomainMapping

Get information about a domain mapping.

Parameters:

  • name (String)

    Required. The name of the domain mapping to retrieve. For Cloud Run (fully managed), replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/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



2094
2095
2096
2097
2098
2099
2100
2101
2102
# File 'lib/google/apis/run_v1/service.rb', line 2094

def get_project_location_domainmapping(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::DomainMapping::Representation
  command.response_class = Google::Apis::RunV1::DomainMapping
  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_instance_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Policy

Get the IAM Access Control policy currently in effect for the given instance. 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



2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
# File 'lib/google/apis/run_v1/service.rb', line 2196

def get_project_location_instance_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::RunV1::Policy::Representation
  command.response_class = Google::Apis::RunV1::Policy
  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_job_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Policy

Get 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



2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
# File 'lib/google/apis/run_v1/service.rb', line 2313

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, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::RunV1::Policy::Representation
  command.response_class = Google::Apis::RunV1::Policy
  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::RunV1::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



2450
2451
2452
2453
2454
2455
2456
2457
2458
# File 'lib/google/apis/run_v1/service.rb', line 2450

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RunV1::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_revision(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Revision

Get information about a revision.

Parameters:

  • name (String)

    The name of the revision to retrieve. For Cloud Run (fully managed), replace namespace with the project ID or number. It takes the form namespaces/ namespace. For example: namespaces/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



2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'lib/google/apis/run_v1/service.rb', line 2623

def get_project_location_revision(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Revision::Representation
  command.response_class = Google::Apis::RunV1::Revision
  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_route(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Route

Get information about a route.

Parameters:

  • name (String)

    The name of the route to retrieve. For Cloud Run (fully managed), replace namespace with the project ID or number. It takes the form namespaces/ namespace. For example: namespaces/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



2713
2714
2715
2716
2717
2718
2719
2720
2721
# File 'lib/google/apis/run_v1/service.rb', line 2713

def get_project_location_route(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RunV1::Route::Representation
  command.response_class = Google::Apis::RunV1::Route
  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::RunV1::Service

Gets information about a service.

Parameters:

  • name (String)

    Required. The fully qualified name of the service to retrieve. It can be any of the following forms: * namespaces/project_id_or_number/services/ service_name(only when the `endpoint` is regional) * `projects/` project_id_or_number`/locations/`region`/services/`service_name * projects/ project_id_or_number/regions/region/services/service_name``

  • 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



2894
2895
2896
2897
2898
2899
2900
2901
2902
# File 'lib/google/apis/run_v1/service.rb', line 2894

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

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



2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
# File 'lib/google/apis/run_v1/service.rb', line 2938

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, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::RunV1::Policy::Representation
  command.response_class = Google::Apis::RunV1::Policy
  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_workerpool_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Policy

Get the IAM Access Control policy currently in effect for the given worker pool. 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



3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
# File 'lib/google/apis/run_v1/service.rb', line 3156

def get_project_location_workerpool_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::RunV1::Policy::Representation
  command.response_class = Google::Apis::RunV1::Policy
  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

#list_namespace_authorizeddomains(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::ListAuthorizedDomainsResponse

List authorized domains.

Parameters:

  • parent (String)

    Name of the parent Project resource. Example: projects/myproject.

  • page_size (Fixnum) (defaults to: nil)

    Maximum results to return per page.

  • page_token (String) (defaults to: nil)

    Continuation token for fetching the next page of results.

  • 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



81
82
83
84
85
86
87
88
89
90
91
# File 'lib/google/apis/run_v1/service.rb', line 81

def list_namespace_authorizeddomains(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apis/domains.cloudrun.com/v1/{+parent}/authorizeddomains', options)
  command.response_representation = Google::Apis::RunV1::ListAuthorizedDomainsResponse::Representation
  command.response_class = Google::Apis::RunV1::ListAuthorizedDomainsResponse
  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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_namespace_configurations(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::RunV1::ListConfigurationsResponse

List configurations. Results are sorted by creation time, descending.

Parameters:

  • parent (String)

    The namespace from which the configurations should be listed. For Cloud Run, replace namespace_id with the project ID or number.

  • continue (String) (defaults to: nil)

    Optional. Encoded string to continue paging.

  • field_selector (String) (defaults to: nil)

    Not supported by Cloud Run.

  • include_uninitialized (Boolean) (defaults to: nil)

    Not supported 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)

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

  • resource_version (String) (defaults to: nil)

    Not supported by Cloud Run.

  • watch (Boolean) (defaults to: nil)

    Not supported 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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
# File 'lib/google/apis/run_v1/service.rb', line 160

def list_namespace_configurations(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/serving.knative.dev/v1/{+parent}/configurations', options)
  command.response_representation = Google::Apis::RunV1::ListConfigurationsResponse::Representation
  command.response_class = Google::Apis::RunV1::ListConfigurationsResponse
  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

#list_namespace_domainmappings(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::RunV1::ListDomainMappingsResponse

List all domain mappings.

Parameters:

  • parent (String)

    Required. The namespace from which the domain mappings should be listed. For Cloud Run (fully managed), replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/PROJECT_ID

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

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

  • 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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
# File 'lib/google/apis/run_v1/service.rb', line 336

def list_namespace_domainmappings(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/domains.cloudrun.com/v1/{+parent}/domainmappings', options)
  command.response_representation = Google::Apis::RunV1::ListDomainMappingsResponse::Representation
  command.response_class = Google::Apis::RunV1::ListDomainMappingsResponse
  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

#list_namespace_executions(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::RunV1::ListExecutionsResponse

List executions. Results are sorted by creation time, descending.

Parameters:

  • parent (String)

    Required. The namespace from which the executions should be listed. Replace namespace with the project ID or number. It takes the form namespaces/ namespace. For example: namespaces/PROJECT_ID

  • continue (String) (defaults to: nil)

    Optional. Optional encoded string to continue paging.

  • field_selector (String) (defaults to: nil)

    Optional. Not supported by Cloud Run.

  • include_uninitialized (Boolean) (defaults to: nil)

    Optional. Not supported 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 the records that should be returned.

  • resource_version (String) (defaults to: nil)

    Optional. Not supported by Cloud Run.

  • watch (Boolean) (defaults to: nil)

    Optional. Not supported 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



499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
# File 'lib/google/apis/run_v1/service.rb', line 499

def list_namespace_executions(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/v1/{+parent}/executions', options)
  command.response_representation = Google::Apis::RunV1::ListExecutionsResponse::Representation
  command.response_class = Google::Apis::RunV1::ListExecutionsResponse
  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

#list_namespace_instances(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::RunV1::ListInstancesResponse

List Instances. Results are sorted by creation time, descending.

Parameters:

  • parent (String)

    Required. The namespace from which the Instances should be listed. Replace namespace with the project ID or number. It takes the form namespaces/ namespace. For example: namespaces/PROJECT_ID

  • continue (String) (defaults to: nil)

    Optional. Optional encoded string to continue paging.

  • field_selector (String) (defaults to: nil)

    Optional. Not supported by Cloud Run.

  • include_uninitialized (Boolean) (defaults to: nil)

    Optional. Not supported 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. Not supported by Cloud Run.

  • watch (Boolean) (defaults to: nil)

    Optional. Not supported 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



663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
# File 'lib/google/apis/run_v1/service.rb', line 663

def list_namespace_instances(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/v1/{+parent}/instances', options)
  command.response_representation = Google::Apis::RunV1::ListInstancesResponse::Representation
  command.response_class = Google::Apis::RunV1::ListInstancesResponse
  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

#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::RunV1::ListJobsResponse

List jobs. Results are sorted by creation time, descending.

Parameters:

  • parent (String)

    Required. The namespace from which the jobs should be listed. Replace namespace with the project ID or number. It takes the form namespaces/ namespace. For example: namespaces/PROJECT_ID

  • continue (String) (defaults to: nil)

    Optional. Optional encoded string to continue paging.

  • field_selector (String) (defaults to: nil)

    Optional. Not supported by Cloud Run.

  • include_uninitialized (Boolean) (defaults to: nil)

    Optional. Not supported 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. Not supported by Cloud Run.

  • watch (Boolean) (defaults to: nil)

    Optional. Not supported 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



932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
# File 'lib/google/apis/run_v1/service.rb', line 932

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/v1/{+parent}/jobs', options)
  command.response_representation = Google::Apis::RunV1::ListJobsResponse::Representation
  command.response_class = Google::Apis::RunV1::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

#list_namespace_revisions(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::RunV1::ListRevisionsResponse

List revisions. Results are sorted by creation time, descending.

Parameters:

  • parent (String)

    The namespace from which the revisions should be listed. For Cloud Run (fully managed), replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/PROJECT_ID

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

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

  • 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



1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'lib/google/apis/run_v1/service.rb', line 1141

def list_namespace_revisions(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/serving.knative.dev/v1/{+parent}/revisions', options)
  command.response_representation = Google::Apis::RunV1::ListRevisionsResponse::Representation
  command.response_class = Google::Apis::RunV1::ListRevisionsResponse
  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

#list_namespace_routes(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::RunV1::ListRoutesResponse

List routes. Results are sorted by creation time, descending.

Parameters:

  • parent (String)

    The namespace from which the routes should be listed. For Cloud Run (fully managed), replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/PROJECT_ID

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

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

  • 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



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
# File 'lib/google/apis/run_v1/service.rb', line 1231

def list_namespace_routes(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/serving.knative.dev/v1/{+parent}/routes', options)
  command.response_representation = Google::Apis::RunV1::ListRoutesResponse::Representation
  command.response_class = Google::Apis::RunV1::ListRoutesResponse
  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

#list_namespace_services(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::RunV1::ListServicesResponse

Lists services for the given project and region. Results are sorted by creation time, descending.

Parameters:

  • parent (String)

    Required. The parent from where the resources should be listed. In Cloud Run, it may be one of the following: * project_id_or_number * namespaces/ project_id_or_number* `namespaces/`project_id_or_number`/services` * ` projects/`project_id_or_number`/locations/`region * projects/ project_id_or_number/regions/region``

  • continue (String) (defaults to: nil)

    Encoded string to continue paging.

  • field_selector (String) (defaults to: nil)

    Not supported, and ignored by Cloud Run.

  • include_uninitialized (Boolean) (defaults to: nil)

    Not supported, and ignored 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)

    The maximum number of records that should be returned.

  • resource_version (String) (defaults to: nil)

    Not supported, and ignored by Cloud Run.

  • watch (Boolean) (defaults to: nil)

    Not supported, and ignored 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



1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
# File 'lib/google/apis/run_v1/service.rb', line 1411

def list_namespace_services(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/serving.knative.dev/v1/{+parent}/services', options)
  command.response_representation = Google::Apis::RunV1::ListServicesResponse::Representation
  command.response_class = Google::Apis::RunV1::ListServicesResponse
  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

#list_namespace_tasks(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::RunV1::ListTasksResponse

List tasks.

Parameters:

  • parent (String)

    Required. The namespace from which the tasks should be listed. Replace namespace with the project ID or number. It takes the form namespaces/ namespace. For example: namespaces/PROJECT_ID

  • continue (String) (defaults to: nil)

    Optional. Optional encoded string to continue paging.

  • field_selector (String) (defaults to: nil)

    Optional. Not supported by Cloud Run.

  • include_uninitialized (Boolean) (defaults to: nil)

    Optional. Not supported 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. For example, to list all tasks of execution " foo" in succeeded state: run.googleapis.com/execution=foo,run.googleapis.com/ runningState=Succeeded. Supported states are: * Pending: Initial state of all tasks. The task has not yet started but eventually will. * Running: Container instances for this task are running or will be running shortly. * Succeeded: No more container instances to run for the task, and the last attempt succeeded. * Failed: No more container instances to run for the task, and the last attempt failed. This task has run out of retry attempts. * Cancelled: Task was running but got stopped because its parent execution has been aborted. * Abandoned: The task has not yet started and never will because its parent execution has been aborted.

  • limit (Fixnum) (defaults to: nil)

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

  • resource_version (String) (defaults to: nil)

    Optional. Not supported by Cloud Run.

  • watch (Boolean) (defaults to: nil)

    Optional. Not supported 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



1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
# File 'lib/google/apis/run_v1/service.rb', line 1551

def list_namespace_tasks(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/v1/{+parent}/tasks', options)
  command.response_representation = Google::Apis::RunV1::ListTasksResponse::Representation
  command.response_class = Google::Apis::RunV1::ListTasksResponse
  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

#list_namespace_workerpools(parent, continue: nil, label_selector: nil, limit: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::ListWorkerPoolsResponse

Lists worker pools for the given project and region. Results are sorted by creation time, descending.

Parameters:

  • parent (String)

    Required. The parent from where the resources should be listed. In Cloud Run, it may be one of the following: * project_id_or_number * namespaces/ project_id_or_number* `namespaces/`project_id_or_number`/workerpools` * ` projects/`project_id_or_number`/locations/`region * projects/ project_id_or_number/regions/region``

  • continue (String) (defaults to: nil)

    Encoded string to continue paging.

  • label_selector (String) (defaults to: nil)

    =, !=, exists, in, and notIn.

  • limit (Fixnum) (defaults to: nil)

    The maximum number of records that should be returned.

  • 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



1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
# File 'lib/google/apis/run_v1/service.rb', line 1716

def list_namespace_workerpools(parent, continue: nil, label_selector: nil, limit: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apis/run.googleapis.com/v1/{+parent}/workerpools', options)
  command.response_representation = Google::Apis::RunV1::ListWorkerPoolsResponse::Representation
  command.response_class = Google::Apis::RunV1::ListWorkerPoolsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['continue'] = continue unless continue.nil?
  command.query['labelSelector'] = label_selector unless label_selector.nil?
  command.query['limit'] = limit unless limit.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_authorizeddomains(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::ListAuthorizedDomainsResponse

List authorized domains.

Parameters:

  • parent (String)

    Name of the parent Project resource. Example: projects/myproject.

  • page_size (Fixnum) (defaults to: nil)

    Maximum results to return per page.

  • page_token (String) (defaults to: nil)

    Continuation token for fetching the next page of results.

  • 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



1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
# File 'lib/google/apis/run_v1/service.rb', line 1798

def list_project_authorizeddomains(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/authorizeddomains', options)
  command.response_representation = Google::Apis::RunV1::ListAuthorizedDomainsResponse::Representation
  command.response_class = Google::Apis::RunV1::ListAuthorizedDomainsResponse
  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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_authorizeddomains(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::ListAuthorizedDomainsResponse

List authorized domains.

Parameters:

  • parent (String)

    Name of the parent Project resource. Example: projects/myproject.

  • page_size (Fixnum) (defaults to: nil)

    Maximum results to return per page.

  • page_token (String) (defaults to: nil)

    Continuation token for fetching the next page of results.

  • 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



1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
# File 'lib/google/apis/run_v1/service.rb', line 1890

def list_project_location_authorizeddomains(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/authorizeddomains', options)
  command.response_representation = Google::Apis::RunV1::ListAuthorizedDomainsResponse::Representation
  command.response_class = Google::Apis::RunV1::ListAuthorizedDomainsResponse
  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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_configurations(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::RunV1::ListConfigurationsResponse

List configurations. Results are sorted by creation time, descending.

Parameters:

  • parent (String)

    The namespace from which the configurations should be listed. For Cloud Run, replace namespace_id with the project ID or number.

  • continue (String) (defaults to: nil)

    Optional. Encoded string to continue paging.

  • field_selector (String) (defaults to: nil)

    Not supported by Cloud Run.

  • include_uninitialized (Boolean) (defaults to: nil)

    Not supported 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)

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

  • resource_version (String) (defaults to: nil)

    Not supported by Cloud Run.

  • watch (Boolean) (defaults to: nil)

    Not supported 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



1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
# File 'lib/google/apis/run_v1/service.rb', line 1969

def list_project_location_configurations(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, 'v1/{+parent}/configurations', options)
  command.response_representation = Google::Apis::RunV1::ListConfigurationsResponse::Representation
  command.response_class = Google::Apis::RunV1::ListConfigurationsResponse
  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

#list_project_location_domainmappings(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::RunV1::ListDomainMappingsResponse

List all domain mappings.

Parameters:

  • parent (String)

    Required. The namespace from which the domain mappings should be listed. For Cloud Run (fully managed), replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/PROJECT_ID

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

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

  • 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



2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
# File 'lib/google/apis/run_v1/service.rb', line 2145

def list_project_location_domainmappings(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, 'v1/{+parent}/domainmappings', options)
  command.response_representation = Google::Apis::RunV1::ListDomainMappingsResponse::Representation
  command.response_class = Google::Apis::RunV1::ListDomainMappingsResponse
  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

#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::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.

  • return_partial_success (Boolean) (defaults to: nil)

    When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse. unreachable field. This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-". This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific 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



2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
# File 'lib/google/apis/run_v1/service.rb', line 2501

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::RunV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::RunV1::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['returnPartialSuccess'] = return_partial_success unless return_partial_success.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_revisions(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::RunV1::ListRevisionsResponse

List revisions. Results are sorted by creation time, descending.

Parameters:

  • parent (String)

    The namespace from which the revisions should be listed. For Cloud Run (fully managed), replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/PROJECT_ID

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

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

  • 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



2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
# File 'lib/google/apis/run_v1/service.rb', line 2674

def list_project_location_revisions(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, 'v1/{+parent}/revisions', options)
  command.response_representation = Google::Apis::RunV1::ListRevisionsResponse::Representation
  command.response_class = Google::Apis::RunV1::ListRevisionsResponse
  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

#list_project_location_routes(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::RunV1::ListRoutesResponse

List routes. Results are sorted by creation time, descending.

Parameters:

  • parent (String)

    The namespace from which the routes should be listed. For Cloud Run (fully managed), replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/PROJECT_ID

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

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

  • 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



2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
# File 'lib/google/apis/run_v1/service.rb', line 2764

def list_project_location_routes(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, 'v1/{+parent}/routes', options)
  command.response_representation = Google::Apis::RunV1::ListRoutesResponse::Representation
  command.response_class = Google::Apis::RunV1::ListRoutesResponse
  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

#list_project_location_services(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::RunV1::ListServicesResponse

Lists services for the given project and region. Results are sorted by creation time, descending.

Parameters:

  • parent (String)

    Required. The parent from where the resources should be listed. In Cloud Run, it may be one of the following: * project_id_or_number * namespaces/ project_id_or_number* `namespaces/`project_id_or_number`/services` * ` projects/`project_id_or_number`/locations/`region * projects/ project_id_or_number/regions/region``

  • continue (String) (defaults to: nil)

    Encoded string to continue paging.

  • field_selector (String) (defaults to: nil)

    Not supported, and ignored by Cloud Run.

  • include_uninitialized (Boolean) (defaults to: nil)

    Not supported, and ignored 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)

    The maximum number of records that should be returned.

  • resource_version (String) (defaults to: nil)

    Not supported, and ignored by Cloud Run.

  • watch (Boolean) (defaults to: nil)

    Not supported, and ignored 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



2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
# File 'lib/google/apis/run_v1/service.rb', line 2989

def list_project_location_services(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, 'v1/{+parent}/services', options)
  command.response_representation = Google::Apis::RunV1::ListServicesResponse::Representation
  command.response_class = Google::Apis::RunV1::ListServicesResponse
  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

#list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::ListLocationsResponse

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ ListLocationsRequest.name] field: * Global locations: If name is empty, the method lists the public locations available to all projects. * Project- specific locations: If name follows the format projects/project`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as thename` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

Parameters:

  • name (String)

    The resource that owns the locations collection, if applicable.

  • extra_location_types (Array<String>, String) (defaults to: nil)

    Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.

  • filter (String) (defaults to: nil)

    A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of results to return. If not set, the service selects a default.

  • page_token (String) (defaults to: nil)

    A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

  • 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



1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
# File 'lib/google/apis/run_v1/service.rb', line 1852

def list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/locations', options)
  command.response_representation = Google::Apis::RunV1::ListLocationsResponse::Representation
  command.response_class = Google::Apis::RunV1::ListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['extraLocationTypes'] = extra_location_types unless extra_location_types.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

#replace_namespace_instance_instance(name, instance_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Instance

Replace an Instance.

Parameters:

  • name (String)

    Required. The name of the Instance being replaced. Replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/PROJECT_ID

  • instance_object (Google::Apis::RunV1::Instance) (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



703
704
705
706
707
708
709
710
711
712
713
# File 'lib/google/apis/run_v1/service.rb', line 703

def replace_namespace_instance_instance(name, instance_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'apis/run.googleapis.com/v1/{+name}', options)
  command.request_representation = Google::Apis::RunV1::Instance::Representation
  command.request_object = instance_object
  command.response_representation = Google::Apis::RunV1::Instance::Representation
  command.response_class = Google::Apis::RunV1::Instance
  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

#replace_namespace_job_job(name, job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Job

Replace a job. Only the spec and metadata labels and annotations are modifiable. After the Replace request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.

Parameters:

  • name (String)

    Required. The name of the job being replaced. Replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/PROJECT_ID

  • job_object (Google::Apis::RunV1::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



975
976
977
978
979
980
981
982
983
984
985
# File 'lib/google/apis/run_v1/service.rb', line 975

def replace_namespace_job_job(name, job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'apis/run.googleapis.com/v1/{+name}', options)
  command.request_representation = Google::Apis::RunV1::Job::Representation
  command.request_object = job_object
  command.response_representation = Google::Apis::RunV1::Job::Representation
  command.response_class = Google::Apis::RunV1::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

#replace_namespace_service_service(name, service_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Service

Replaces a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.

Parameters:

  • name (String)

    Required. The fully qualified name of the service to replace. It can be any of the following forms: * namespaces/project_id_or_number/services/ service_name(only when the `endpoint` is regional) * `projects/` project_id_or_number`/locations/`region`/services/`service_name * projects/ project_id_or_number/regions/region/services/service_name``

  • service_object (Google::Apis::RunV1::Service) (defaults to: nil)
  • dry_run (String) (defaults to: nil)

    Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

  • 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



1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
# File 'lib/google/apis/run_v1/service.rb', line 1459

def replace_namespace_service_service(name, service_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'apis/serving.knative.dev/v1/{+name}', options)
  command.request_representation = Google::Apis::RunV1::Service::Representation
  command.request_object = service_object
  command.response_representation = Google::Apis::RunV1::Service::Representation
  command.response_class = Google::Apis::RunV1::Service
  command.params['name'] = name unless name.nil?
  command.query['dryRun'] = dry_run unless dry_run.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#replace_namespace_workerpool_worker_pool(name, worker_pool_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::WorkerPool

Replaces a worker pool. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.

Parameters:

  • name (String)

    Required. The fully qualified name of the worker pool to replace. It can be any of the following forms: * namespaces/project_id_or_number/workerpools/ worker_pool_name(only when the `endpoint` is regional) * `projects/` project_id_or_number`/locations/`region`/workerpools/`worker_pool_name * projects/project_id_or_number/regions/region/workerpools/worker_pool_name

  • worker_pool_object (Google::Apis::RunV1::WorkerPool) (defaults to: nil)
  • dry_run (String) (defaults to: nil)

    Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

  • 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



1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
# File 'lib/google/apis/run_v1/service.rb', line 1761

def replace_namespace_workerpool_worker_pool(name, worker_pool_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'apis/run.googleapis.com/v1/{+name}', options)
  command.request_representation = Google::Apis::RunV1::WorkerPool::Representation
  command.request_object = worker_pool_object
  command.response_representation = Google::Apis::RunV1::WorkerPool::Representation
  command.response_class = Google::Apis::RunV1::WorkerPool
  command.params['name'] = name unless name.nil?
  command.query['dryRun'] = dry_run unless dry_run.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#replace_project_location_service_service(name, service_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Service

Replaces a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.

Parameters:

  • name (String)

    Required. The fully qualified name of the service to replace. It can be any of the following forms: * namespaces/project_id_or_number/services/ service_name(only when the `endpoint` is regional) * `projects/` project_id_or_number`/locations/`region`/services/`service_name * projects/ project_id_or_number/regions/region/services/service_name``

  • service_object (Google::Apis::RunV1::Service) (defaults to: nil)
  • dry_run (String) (defaults to: nil)

    Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

  • 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



3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
# File 'lib/google/apis/run_v1/service.rb', line 3037

def replace_project_location_service_service(name, service_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::RunV1::Service::Representation
  command.request_object = service_object
  command.response_representation = Google::Apis::RunV1::Service::Representation
  command.response_class = Google::Apis::RunV1::Service
  command.params['name'] = name unless name.nil?
  command.query['dryRun'] = dry_run unless dry_run.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_job(name, run_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Execution

Trigger creation of a new execution of this job.

Parameters:

  • name (String)

    Required. The name of the job to run. Replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/ PROJECT_ID

  • run_job_request_object (Google::Apis::RunV1::RunJobRequest) (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



1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
# File 'lib/google/apis/run_v1/service.rb', line 1010

def run_job(name, run_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'apis/run.googleapis.com/v1/{+name}:run', options)
  command.request_representation = Google::Apis::RunV1::RunJobRequest::Representation
  command.request_object = run_job_request_object
  command.response_representation = Google::Apis::RunV1::Execution::Representation
  command.response_class = Google::Apis::RunV1::Execution
  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_instance_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Policy

Sets the IAM Access control policy for the specified instance. 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.

  • set_iam_policy_request_object (Google::Apis::RunV1::SetIamPolicyRequest) (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



2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'lib/google/apis/run_v1/service.rb', line 2231

def set_instance_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::RunV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::RunV1::Policy::Representation
  command.response_class = Google::Apis::RunV1::Policy
  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_job_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Policy

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.

  • set_iam_policy_request_object (Google::Apis::RunV1::SetIamPolicyRequest) (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



2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
# File 'lib/google/apis/run_v1/service.rb', line 2348

def set_job_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::RunV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::RunV1::Policy::Representation
  command.response_class = Google::Apis::RunV1::Policy
  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_service_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Policy

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.

  • set_iam_policy_request_object (Google::Apis::RunV1::SetIamPolicyRequest) (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



3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
# File 'lib/google/apis/run_v1/service.rb', line 3074

def set_service_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::RunV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::RunV1::Policy::Representation
  command.response_class = Google::Apis::RunV1::Policy
  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_workerpool_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Policy

Sets the IAM Access control policy for the specified worker pool. 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.

  • set_iam_policy_request_object (Google::Apis::RunV1::SetIamPolicyRequest) (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



3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
# File 'lib/google/apis/run_v1/service.rb', line 3191

def set_workerpool_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::RunV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::RunV1::Policy::Representation
  command.response_class = Google::Apis::RunV1::Policy
  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

#start_instance(name, start_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Instance

Start an Instance which has been stopped.

Parameters:

  • name (String)

    Required. The name of the Instance to run. Replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/PROJECT_ID

  • start_instance_request_object (Google::Apis::RunV1::StartInstanceRequest) (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



738
739
740
741
742
743
744
745
746
747
748
# File 'lib/google/apis/run_v1/service.rb', line 738

def start_instance(name, start_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'apis/run.googleapis.com/v1/{+name}:start', options)
  command.request_representation = Google::Apis::RunV1::StartInstanceRequest::Representation
  command.request_object = start_instance_request_object
  command.response_representation = Google::Apis::RunV1::Instance::Representation
  command.response_class = Google::Apis::RunV1::Instance
  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

#stop_instance(name, stop_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::Instance

Stop an Instance that is running.

Parameters:

  • name (String)

    Required. The name of the Instance to run. Replace namespace with the project ID or number. It takes the form namespaces/namespace. For example: namespaces/PROJECT_ID

  • stop_instance_request_object (Google::Apis::RunV1::StopInstanceRequest) (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



773
774
775
776
777
778
779
780
781
782
783
# File 'lib/google/apis/run_v1/service.rb', line 773

def stop_instance(name, stop_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'apis/run.googleapis.com/v1/{+name}:stop', options)
  command.request_representation = Google::Apis::RunV1::StopInstanceRequest::Representation
  command.request_object = stop_instance_request_object
  command.response_representation = Google::Apis::RunV1::Instance::Representation
  command.response_class = Google::Apis::RunV1::Instance
  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

#test_instance_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified instance. 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.

  • test_iam_permissions_request_object (Google::Apis::RunV1::TestIamPermissionsRequest) (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



2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
# File 'lib/google/apis/run_v1/service.rb', line 2267

def test_instance_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::RunV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::RunV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::RunV1::TestIamPermissionsResponse
  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_job_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified job. 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.

  • test_iam_permissions_request_object (Google::Apis::RunV1::TestIamPermissionsRequest) (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



2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
# File 'lib/google/apis/run_v1/service.rb', line 2384

def test_job_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::RunV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::RunV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::RunV1::TestIamPermissionsResponse
  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_service_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::TestIamPermissionsResponse

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.

  • test_iam_permissions_request_object (Google::Apis::RunV1::TestIamPermissionsRequest) (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



3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
# File 'lib/google/apis/run_v1/service.rb', line 3110

def test_service_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::RunV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::RunV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::RunV1::TestIamPermissionsResponse
  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_workerpool_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RunV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified worker pool. 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.

  • test_iam_permissions_request_object (Google::Apis::RunV1::TestIamPermissionsRequest) (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



3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
# File 'lib/google/apis/run_v1/service.rb', line 3227

def test_workerpool_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::RunV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::RunV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::RunV1::TestIamPermissionsResponse
  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::RunV1::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::RunV1::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



2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'lib/google/apis/run_v1/service.rb', line 2543

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, 'v1/{+name}:wait', options)
  command.request_representation = Google::Apis::RunV1::GoogleLongrunningWaitOperationRequest::Representation
  command.request_object = google_longrunning_wait_operation_request_object
  command.response_representation = Google::Apis::RunV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RunV1::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