Class: Google::Apis::RuntimeconfigV1beta1::CloudRuntimeConfigService

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

Overview

Cloud Runtime Configuration API

The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.

Examples:

require 'google/apis/runtimeconfig_v1beta1'

Runtimeconfig = Google::Apis::RuntimeconfigV1beta1 # Alias the module
service = Runtimeconfig::CloudRuntimeConfigService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeCloudRuntimeConfigService

Returns a new instance of CloudRuntimeConfigService.


48
49
50
51
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 48

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


41
42
43
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 41

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.


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

def quota_user
  @quota_user
end

Instance Method Details

#create_project_config(parent, runtime_config_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RuntimeconfigV1beta1::RuntimeConfig

Creates a new RuntimeConfig resource. The configuration name must be unique within project.

Parameters:

  • parent (String)

    The project ID for this request, in the format projects/[PROJECT_ID].

  • runtime_config_object (Google::Apis::RuntimeconfigV1beta1::RuntimeConfig) (defaults to: nil)
  • request_id (String) (defaults to: nil)

    An optional but recommended unique request_id. If the server receives two create() requests with the same request_id, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty request_id fields are ignored. It is responsibility of the client to ensure uniqueness of the request_id strings. request_id strings are limited to 64 characters.

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


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

def create_project_config(parent, runtime_config_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/configs', options)
  command.request_representation = Google::Apis::RuntimeconfigV1beta1::RuntimeConfig::Representation
  command.request_object = runtime_config_object
  command.response_representation = Google::Apis::RuntimeconfigV1beta1::RuntimeConfig::Representation
  command.response_class = Google::Apis::RuntimeconfigV1beta1::RuntimeConfig
  command.params['parent'] = parent unless parent.nil?
  command.query['requestId'] = request_id unless request_id.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_config_variable(parent, variable_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RuntimeconfigV1beta1::Variable

Creates a variable within the given configuration. You cannot create a variable with a name that is a prefix of an existing variable name, or a name that has an existing variable name as a prefix. To learn more about creating a variable, read the Setting and Getting Data documentation.

Parameters:

  • parent (String)

    The path to the RutimeConfig resource that this variable should belong to. The configuration must exist beforehand; the path must be in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]

  • variable_object (Google::Apis::RuntimeconfigV1beta1::Variable) (defaults to: nil)
  • request_id (String) (defaults to: nil)

    An optional but recommended unique request_id. If the server receives two create() requests with the same request_id, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty request_id fields are ignored. It is responsibility of the client to ensure uniqueness of the request_id strings. request_id strings are limited to 64 characters.

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


460
461
462
463
464
465
466
467
468
469
470
471
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 460

def create_project_config_variable(parent, variable_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/variables', options)
  command.request_representation = Google::Apis::RuntimeconfigV1beta1::Variable::Representation
  command.request_object = variable_object
  command.response_representation = Google::Apis::RuntimeconfigV1beta1::Variable::Representation
  command.response_class = Google::Apis::RuntimeconfigV1beta1::Variable
  command.params['parent'] = parent unless parent.nil?
  command.query['requestId'] = request_id unless request_id.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_config_waiter(parent, waiter_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RuntimeconfigV1beta1::Operation

Creates a Waiter resource. This operation returns a long-running Operation resource which can be polled for completion. However, a waiter with the given name will exist (and can be retrieved) prior to the operation completing. If the operation fails, the failed Waiter resource will still exist and must be deleted prior to subsequent creation attempts.

Parameters:

  • parent (String)

    The path to the configuration that will own the waiter. The configuration must exist beforehand; the path must be in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME].

  • waiter_object (Google::Apis::RuntimeconfigV1beta1::Waiter) (defaults to: nil)
  • request_id (String) (defaults to: nil)

    An optional but recommended unique request_id. If the server receives two create() requests with the same request_id, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty request_id fields are ignored. It is responsibility of the client to ensure uniqueness of the request_id strings. request_id strings are limited to 64 characters.

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


749
750
751
752
753
754
755
756
757
758
759
760
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 749

def create_project_config_waiter(parent, waiter_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/waiters', options)
  command.request_representation = Google::Apis::RuntimeconfigV1beta1::Waiter::Representation
  command.request_object = waiter_object
  command.response_representation = Google::Apis::RuntimeconfigV1beta1::Operation::Representation
  command.response_class = Google::Apis::RuntimeconfigV1beta1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['requestId'] = request_id unless request_id.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_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RuntimeconfigV1beta1::Empty

Deletes a RuntimeConfig resource.

Parameters:

  • name (String)

    The RuntimeConfig resource to delete, in the format: projects/[PROJECT_ID]/configs/[CONFIG_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:


120
121
122
123
124
125
126
127
128
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 120

def delete_project_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::RuntimeconfigV1beta1::Empty::Representation
  command.response_class = Google::Apis::RuntimeconfigV1beta1::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_config_variable(name, recursive: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RuntimeconfigV1beta1::Empty

Deletes a variable or multiple variables. If you specify a variable name, then that variable is deleted. If you specify a prefix and recursive is true, then all variables with that prefix are deleted. You must set a recursive to true if you delete variables by prefix.

Parameters:

  • name (String)

    The name of the variable to delete, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]

  • recursive (Boolean) (defaults to: nil)

    Set to true to recursively delete multiple variables with the same prefix.

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


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

def delete_project_config_variable(name, recursive: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::RuntimeconfigV1beta1::Empty::Representation
  command.response_class = Google::Apis::RuntimeconfigV1beta1::Empty
  command.params['name'] = name unless name.nil?
  command.query['recursive'] = recursive unless recursive.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_config_waiter(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RuntimeconfigV1beta1::Empty

Deletes the waiter with the specified name.

Parameters:

  • name (String)

    The Waiter resource to delete, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_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:


783
784
785
786
787
788
789
790
791
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 783

def delete_project_config_waiter(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::RuntimeconfigV1beta1::Empty::Representation
  command.response_class = Google::Apis::RuntimeconfigV1beta1::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

#get_project_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RuntimeconfigV1beta1::RuntimeConfig

Gets information about a RuntimeConfig resource.

Parameters:

  • name (String)

    The name of the RuntimeConfig resource to retrieve, in the format: projects/[PROJECT_ID]/configs/[CONFIG_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:


151
152
153
154
155
156
157
158
159
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 151

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

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil)

    Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.

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


191
192
193
194
195
196
197
198
199
200
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 191

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

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:


373
374
375
376
377
378
379
380
381
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 373

def get_project_config_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::RuntimeconfigV1beta1::Operation::Representation
  command.response_class = Google::Apis::RuntimeconfigV1beta1::Operation
  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_config_variable(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RuntimeconfigV1beta1::Variable

Gets information about a single variable.

Parameters:

  • name (String)

    The name of the variable to return, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_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:


533
534
535
536
537
538
539
540
541
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 533

def get_project_config_variable(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::RuntimeconfigV1beta1::Variable::Representation
  command.response_class = Google::Apis::RuntimeconfigV1beta1::Variable
  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_config_waiter(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RuntimeconfigV1beta1::Waiter

Gets information about a single waiter.

Parameters:

  • name (String)

    The fully-qualified name of the Waiter resource object to retrieve, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_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:


815
816
817
818
819
820
821
822
823
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 815

def get_project_config_waiter(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::RuntimeconfigV1beta1::Waiter::Representation
  command.response_class = Google::Apis::RuntimeconfigV1beta1::Waiter
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_config_variables(parent, filter: nil, page_size: nil, page_token: nil, return_values: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RuntimeconfigV1beta1::ListVariablesResponse

Lists variables within given a configuration, matching any provided filters. This only lists variable names, not the values, unless return_values is true, in which case only variables that user has IAM permission to GetVariable will be returned.

Parameters:

  • parent (String)

    The path to the RuntimeConfig resource for which you want to list variables. The configuration must exist beforehand; the path must be in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]

  • filter (String) (defaults to: nil)

    Filters variables by matching the specified filter. For example: projects/example-project/config/[CONFIG_NAME]/variables/example-variable.

  • page_size (Fixnum) (defaults to: nil)

    Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements.

  • page_token (String) (defaults to: nil)

    Specifies a page token to use. Set pageToken to a nextPageToken returned by a previous list request to get the next page of results.

  • return_values (Boolean) (defaults to: nil)

    The flag indicates whether the user wants to return values of variables. If true, then only those variables that user has IAM GetVariable permission will be returned along with their values.

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


582
583
584
585
586
587
588
589
590
591
592
593
594
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 582

def list_project_config_variables(parent, filter: nil, page_size: nil, page_token: nil, return_values: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/variables', options)
  command.response_representation = Google::Apis::RuntimeconfigV1beta1::ListVariablesResponse::Representation
  command.response_class = Google::Apis::RuntimeconfigV1beta1::ListVariablesResponse
  command.params['parent'] = parent unless parent.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['returnValues'] = return_values unless return_values.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_config_waiters(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RuntimeconfigV1beta1::ListWaitersResponse

List waiters within the given configuration.

Parameters:

  • parent (String)

    The path to the configuration for which you want to get a list of waiters. The configuration must exist beforehand; the path must be in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]

  • page_size (Fixnum) (defaults to: nil)

    Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements.

  • page_token (String) (defaults to: nil)

    Specifies a page token to use. Set pageToken to a nextPageToken returned by a previous list request to get 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:


853
854
855
856
857
858
859
860
861
862
863
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 853

def list_project_config_waiters(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/waiters', options)
  command.response_representation = Google::Apis::RuntimeconfigV1beta1::ListWaitersResponse::Representation
  command.response_class = Google::Apis::RuntimeconfigV1beta1::ListWaitersResponse
  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_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RuntimeconfigV1beta1::ListConfigsResponse

Lists all the RuntimeConfig resources within project.

Parameters:

  • parent (String)

    The project ID for this request, in the format projects/[PROJECT_ID].

  • page_size (Fixnum) (defaults to: nil)

    Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements.

  • page_token (String) (defaults to: nil)

    Specifies a page token to use. Set pageToken to a nextPageToken returned by a previous list request to get 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:


230
231
232
233
234
235
236
237
238
239
240
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 230

def list_project_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/configs', options)
  command.response_representation = Google::Apis::RuntimeconfigV1beta1::ListConfigsResponse::Representation
  command.response_class = Google::Apis::RuntimeconfigV1beta1::ListConfigsResponse
  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

#set_config_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RuntimeconfigV1beta1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED

Parameters:

  • resource (String)

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

  • set_iam_policy_request_object (Google::Apis::RuntimeconfigV1beta1::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:


266
267
268
269
270
271
272
273
274
275
276
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 266

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

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

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String)

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

  • test_iam_permissions_request_object (Google::Apis::RuntimeconfigV1beta1::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:


305
306
307
308
309
310
311
312
313
314
315
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 305

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

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String)

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

  • test_iam_permissions_request_object (Google::Apis::RuntimeconfigV1beta1::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:


410
411
412
413
414
415
416
417
418
419
420
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 410

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

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String)

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

  • test_iam_permissions_request_object (Google::Apis::RuntimeconfigV1beta1::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:


623
624
625
626
627
628
629
630
631
632
633
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 623

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

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String)

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

  • test_iam_permissions_request_object (Google::Apis::RuntimeconfigV1beta1::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:


892
893
894
895
896
897
898
899
900
901
902
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 892

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

#update_project_config(name, runtime_config_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RuntimeconfigV1beta1::RuntimeConfig

Updates a RuntimeConfig resource. The configuration must exist beforehand.

Parameters:

  • name (String)

    The name of the RuntimeConfig resource to update, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]

  • runtime_config_object (Google::Apis::RuntimeconfigV1beta1::RuntimeConfig) (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:


339
340
341
342
343
344
345
346
347
348
349
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 339

def update_project_config(name, runtime_config_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::RuntimeconfigV1beta1::RuntimeConfig::Representation
  command.request_object = runtime_config_object
  command.response_representation = Google::Apis::RuntimeconfigV1beta1::RuntimeConfig::Representation
  command.response_class = Google::Apis::RuntimeconfigV1beta1::RuntimeConfig
  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

#update_project_config_variable(name, variable_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RuntimeconfigV1beta1::Variable

Updates an existing variable with a new value.

Parameters:

  • name (String)

    The name of the variable to update, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]

  • variable_object (Google::Apis::RuntimeconfigV1beta1::Variable) (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:


657
658
659
660
661
662
663
664
665
666
667
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 657

def update_project_config_variable(name, variable_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::RuntimeconfigV1beta1::Variable::Representation
  command.request_object = variable_object
  command.response_representation = Google::Apis::RuntimeconfigV1beta1::Variable::Representation
  command.response_class = Google::Apis::RuntimeconfigV1beta1::Variable
  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

#watch_variable(name, watch_variable_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RuntimeconfigV1beta1::Variable

Watches a specific variable and waits for a change in the variable's value. When there is a change, this method returns the new value or times out. If a variable is deleted while being watched, the variableState state is set to DELETED and the method returns the last known variable value. If you set the deadline for watching to a larger value than internal timeout (60 seconds), the current variable value is returned and the variableState will be VARIABLE_STATE_UNSPECIFIED. To learn more about creating a watcher, read the Watching a Variable for Changes documentation.

Parameters:

  • name (String)

    The name of the variable to watch, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]

  • watch_variable_request_object (Google::Apis::RuntimeconfigV1beta1::WatchVariableRequest) (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:


701
702
703
704
705
706
707
708
709
710
711
# File 'generated/google/apis/runtimeconfig_v1beta1/service.rb', line 701

def watch_variable(name, watch_variable_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:watch', options)
  command.request_representation = Google::Apis::RuntimeconfigV1beta1::WatchVariableRequest::Representation
  command.request_object = watch_variable_request_object
  command.response_representation = Google::Apis::RuntimeconfigV1beta1::Variable::Representation
  command.response_class = Google::Apis::RuntimeconfigV1beta1::Variable
  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