Class: Google::Apis::RedisV1beta1::CloudRedisService

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

Overview

Google Cloud Memorystore for Redis API

Creates and manages Redis instances on the Google Cloud Platform.

Examples:

require 'google/apis/redis_v1beta1'

Redis = Google::Apis::RedisV1beta1 # Alias the module
service = Redis::CloudRedisService.new

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CloudRedisService

Returns a new instance of CloudRedisService.



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

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

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



40
41
42
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



45
46
47
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#add_cluster_token_auth_user(cluster, add_token_auth_user_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Operation

Adds a token auth user for a token based auth enabled cluster.

Parameters:

  • cluster (String) —

    Required. The cluster resource that this token auth user will be added for. Format: projects/project/locations/location/clusters/cluster

  • add_token_auth_user_request_object (Google::Apis::RedisV1beta1::AddTokenAuthUserRequest) (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



632
633
634
635
636
637
638
639
640
641
642
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 632

def add_cluster_token_auth_user(cluster, add_token_auth_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+cluster}:addTokenAuthUser', options)
  command.request_representation = Google::Apis::RedisV1beta1::AddTokenAuthUserRequest::Representation
  command.request_object = add_token_auth_user_request_object
  command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
  command.response_class = Google::Apis::RedisV1beta1::Operation
  command.params['cluster'] = cluster unless cluster.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#add_token_auth_user_auth_token(token_auth_user, add_auth_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Operation

Adds a auth token for a user of a token based auth enabled cluster.

Parameters:

  • token_auth_user (String) —

    Required. The name of the token auth user resource that this auth token will be added for. Format: projects/project/locations/location/clusters/ cluster/tokenAuthUsers/token_auth_user

  • add_auth_token_request_object (Google::Apis::RedisV1beta1::AddAuthTokenRequest) (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



988
989
990
991
992
993
994
995
996
997
998
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 988

def add_token_auth_user_auth_token(token_auth_user, add_auth_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+tokenAuthUser}:addAuthToken', options)
  command.request_representation = Google::Apis::RedisV1beta1::AddAuthTokenRequest::Representation
  command.request_object = add_auth_token_request_object
  command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
  command.response_class = Google::Apis::RedisV1beta1::Operation
  command.params['tokenAuthUser'] = token_auth_user unless token_auth_user.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#backup_cluster(name, backup_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Operation

Backup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the cluster's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.

Parameters:

  • name (String) —

    Required. Redis cluster resource name using the form: projects/project_id/ locations/location_id/clusters/cluster_id`wherelocation_id` refers to a Google Cloud region.

  • backup_cluster_request_object (Google::Apis::RedisV1beta1::BackupClusterRequest) (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



677
678
679
680
681
682
683
684
685
686
687
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 677

def backup_cluster(name, backup_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:backup', options)
  command.request_representation = Google::Apis::RedisV1beta1::BackupClusterRequest::Representation
  command.request_object = backup_cluster_request_object
  command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
  command.response_class = Google::Apis::RedisV1beta1::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

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

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1 , corresponding to Code.CANCELLED.

Parameters:

  • name (String) —

    The name of the operation resource to be cancelled.

  • 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



1693
1694
1695
1696
1697
1698
1699
1700
1701
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 1693

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

#create_project_location_acl_policy(parent, acl_policy_object = nil, acl_policy_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::AclPolicy

Creates an ACL Policy. The creation is executed synchronously and the policy is available for use immediately after the RPC returns.

Parameters:

  • parent (String) —

    Required. The resource name of the cluster location using the form: projects/ project_id/locations/location_id`wherelocation_id` refers to a Google Cloud region.

  • acl_policy_object (Google::Apis::RedisV1beta1::AclPolicy) (defaults to: nil)
  • acl_policy_id (String) (defaults to: nil) —

    Required. The logical name of the ACL Policy in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the customer project / location

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

    Optional. Idempotent request UUID. .

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 206

def create_project_location_acl_policy(parent, acl_policy_object = nil, acl_policy_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/aclPolicies', options)
  command.request_representation = Google::Apis::RedisV1beta1::AclPolicy::Representation
  command.request_object = acl_policy_object
  command.response_representation = Google::Apis::RedisV1beta1::AclPolicy::Representation
  command.response_class = Google::Apis::RedisV1beta1::AclPolicy
  command.params['parent'] = parent unless parent.nil?
  command.query['aclPolicyId'] = acl_policy_id unless acl_policy_id.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_location_cluster(parent, cluster_object = nil, cluster_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Operation

Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters:

  • parent (String) —

    Required. The resource name of the cluster location using the form: projects/ project_id/locations/location_id`wherelocation_id` refers to a Google Cloud region.

  • cluster_object (Google::Apis::RedisV1beta1::Cluster) (defaults to: nil)
  • cluster_id (String) (defaults to: nil) —

    Required. The logical name of the Redis cluster in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the customer project / location

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

    Optional. Idempotent request UUID.

  • 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



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

def create_project_location_cluster(parent, cluster_object = nil, cluster_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/clusters', options)
  command.request_representation = Google::Apis::RedisV1beta1::Cluster::Representation
  command.request_object = cluster_object
  command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
  command.response_class = Google::Apis::RedisV1beta1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['clusterId'] = cluster_id unless cluster_id.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_location_instance(parent, instance_object = nil, instance_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Operation

Creates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project's default network. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. The completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters:

  • parent (String) —

    Required. The resource name of the instance location using the form: projects/ project_id/locations/location_id`wherelocation_id` refers to a GCP region.

  • instance_object (Google::Apis::RedisV1beta1::Instance) (defaults to: nil)
  • instance_id (String) (defaults to: nil) —

    Required. The logical name of the Redis instance in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project / location

  • 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



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

def create_project_location_instance(parent, instance_object = nil, instance_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/instances', options)
  command.request_representation = Google::Apis::RedisV1beta1::Instance::Representation
  command.request_object = instance_object
  command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
  command.response_class = Google::Apis::RedisV1beta1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['instanceId'] = instance_id unless instance_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_location_acl_policy(name, etag: nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Operation

Deletes a specific Acl Policy. This action will delete the Acl Policy and all the rules associated with it. An ACL policy cannot be deleted if it is attached to a cluster.

Parameters:

  • name (String) —

    Required. Redis ACL Policy resource name using the form: projects/project_id /locations/location_id/aclPolicies/acl_policy_id`wherelocation_id` refers to a GCP region.

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

    Optional. Etag of the ACL policy. If this is different from the server's etag, the request will fail with an ABORTED error.

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

    Optional. Idempotent request UUID.

  • 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
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 249

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

Deletes a specific backup.

Parameters:

  • name (String) —

    Required. Redis backup resource name using the form: projects/project_id/ locations/location_id/backupCollections/backup_collection_id/backups/ backup_id``

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

    Optional. Idempotent request UUID.

  • 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



490
491
492
493
494
495
496
497
498
499
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 490

def delete_project_location_backup_collection_backup(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
  command.response_class = Google::Apis::RedisV1beta1::Operation
  command.params['name'] = name unless name.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_location_cluster(name, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Operation

Deletes a specific Redis cluster. Cluster stops serving and data is deleted.

Parameters:

  • name (String) —

    Required. Redis cluster resource name using the form: projects/project_id/ locations/location_id/clusters/cluster_id`wherelocation_id` refers to a Google Cloud region.

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

    Optional. Idempotent request UUID.

  • 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



763
764
765
766
767
768
769
770
771
772
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 763

def delete_project_location_cluster(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
  command.response_class = Google::Apis::RedisV1beta1::Operation
  command.params['name'] = name unless name.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_location_cluster_token_auth_user(name, force: nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Operation

Deletes a token auth user for a token based auth enabled cluster.

Parameters:

  • name (String) —

    Required. The name of the token auth user to delete. Format: projects/project /locations/location/clusters/cluster/tokenAuthUsers/token_auth_user

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

    Optional. If set to true, any child auth tokens of this user will also be deleted. Otherwise, the request will only work if the user has no auth tokens.

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

    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

  • 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



1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 1035

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

Removes a auth token for a user of a token based auth enabled instance.

Parameters:

  • name (String) —

    Required. The name of the token auth user resource that this auth token will be deleted from. Format: projects/project/locations/location/clusters/ cluster/tokenAuthUsers/token_auth_user/authTokens/auth_token

  • 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



1150
1151
1152
1153
1154
1155
1156
1157
1158
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 1150

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

#delete_project_location_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Operation

Deletes a specific Redis instance. Instance stops serving and data is deleted.

Parameters:

  • name (String) —

    Required. Redis instance resource name using the form: projects/project_id/ locations/location_id/instances/instance_id`wherelocation_id` refers to a GCP region.

  • 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



1312
1313
1314
1315
1316
1317
1318
1319
1320
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 1312

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

#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::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



1726
1727
1728
1729
1730
1731
1732
1733
1734
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 1726

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

#export_backup(name, export_backup_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Operation

Exports a specific backup to a customer target Cloud Storage URI.

Parameters:

  • name (String) —

    Required. Redis backup resource name using the form: projects/project_id/ locations/location_id/backupCollections/backup_collection_id/backups/ backup_id``

  • export_backup_request_object (Google::Apis::RedisV1beta1::ExportBackupRequest) (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



524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 524

def export_backup(name, export_backup_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:export', options)
  command.request_representation = Google::Apis::RedisV1beta1::ExportBackupRequest::Representation
  command.request_object = export_backup_request_object
  command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
  command.response_class = Google::Apis::RedisV1beta1::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

#export_instance(name, export_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Operation

Export Redis instance data into a Redis RDB format file in Cloud Storage. Redis will continue serving during this operation. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters:

  • name (String) —

    Required. Redis instance resource name using the form: projects/project_id/ locations/location_id/instances/instance_id`wherelocation_id` refers to a GCP region.

  • export_instance_request_object (Google::Apis::RedisV1beta1::ExportInstanceRequest) (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



1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 1348

def export_instance(name, export_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:export', options)
  command.request_representation = Google::Apis::RedisV1beta1::ExportInstanceRequest::Representation
  command.request_object = export_instance_request_object
  command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
  command.response_class = Google::Apis::RedisV1beta1::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

#failover_instance(name, failover_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Operation

Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.

Parameters:

  • name (String) —

    Required. Redis instance resource name using the form: projects/project_id/ locations/location_id/instances/instance_id`wherelocation_id` refers to a GCP region.

  • failover_instance_request_object (Google::Apis::RedisV1beta1::FailoverInstanceRequest) (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



1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 1384

def failover_instance(name, failover_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:failover', options)
  command.request_representation = Google::Apis::RedisV1beta1::FailoverInstanceRequest::Representation
  command.request_object = failover_instance_request_object
  command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
  command.response_class = Google::Apis::RedisV1beta1::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_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Location

Gets information about a location.

Parameters:

  • name (String) —

    Resource name for the location.

  • 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



74
75
76
77
78
79
80
81
82
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 74

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::RedisV1beta1::Location::Representation
  command.response_class = Google::Apis::RedisV1beta1::Location
  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_acl_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::AclPolicy

Gets the details of a specific Redis Cluster ACL Policy.

Parameters:

  • name (String) —

    Required. Redis ACL Policy resource name using the form: projects/project_id /locations/location_id/aclPolicies/acl_policy_id`wherelocation_id` refers to a GCP region.

  • 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



283
284
285
286
287
288
289
290
291
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 283

def get_project_location_acl_policy(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::RedisV1beta1::AclPolicy::Representation
  command.response_class = Google::Apis::RedisV1beta1::AclPolicy
  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_backup_collection(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::BackupCollection

Get a backup collection.

Parameters:

  • name (String) —

    Required. Redis backupCollection resource name using the form: projects/ project_id/locations/location_id/backupCollections/backup_collection_id` wherelocation_id` refers to a Google Cloud region.

  • 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



410
411
412
413
414
415
416
417
418
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 410

def get_project_location_backup_collection(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::RedisV1beta1::BackupCollection::Representation
  command.response_class = Google::Apis::RedisV1beta1::BackupCollection
  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_backup_collection_backup(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Backup

Gets the details of a specific backup.

Parameters:

  • name (String) —

    Required. Redis backup resource name using the form: projects/project_id/ locations/location_id/backupCollections/backup_collection_id/backups/ backup_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



558
559
560
561
562
563
564
565
566
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 558

def get_project_location_backup_collection_backup(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::RedisV1beta1::Backup::Representation
  command.response_class = Google::Apis::RedisV1beta1::Backup
  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_cluster(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Cluster

Gets the details of a specific Redis cluster.

Parameters:

  • name (String) —

    Required. Redis cluster resource name using the form: projects/project_id/ locations/location_id/clusters/cluster_id`wherelocation_id` refers to a Google Cloud region.

  • 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



796
797
798
799
800
801
802
803
804
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 796

def get_project_location_cluster(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::RedisV1beta1::Cluster::Representation
  command.response_class = Google::Apis::RedisV1beta1::Cluster
  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_cluster_certificate_authority(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::CertificateAuthority

Gets the details of certificate authority information for Redis cluster.

Parameters:

  • name (String) —

    Required. Redis cluster certificate authority resource name using the form: projects/project_id/locations/location_id/clusters/cluster_id/ certificateAuthority where location_id refers to a Google Cloud region.

  • 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



828
829
830
831
832
833
834
835
836
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 828

def get_project_location_cluster_certificate_authority(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::RedisV1beta1::CertificateAuthority::Representation
  command.response_class = Google::Apis::RedisV1beta1::CertificateAuthority
  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_cluster_token_auth_user(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::TokenAuthUser

Gets a specific token auth user for a basic auth enabled cluster.

Parameters:

  • name (String) —

    Required. The name of token auth user for a token based auth enabled cluster. Format: projects/project/locations/location/clusters/cluster/ tokenAuthUsers/token_auth_user

  • 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



1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 1069

def get_project_location_cluster_token_auth_user(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::RedisV1beta1::TokenAuthUser::Representation
  command.response_class = Google::Apis::RedisV1beta1::TokenAuthUser
  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_cluster_token_auth_user_auth_token(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::AuthToken

Gets a specific auth token for a specific token auth user.

Parameters:

  • name (String) —

    Required. The name of auth token for a token based auth enabled cluster. Format: projects/project/locations/location/clusters/cluster/ tokenAuthUsers/token_auth_user/authTokens/auth_token

  • 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



1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 1182

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

Gets the details of a specific Redis instance.

Parameters:

  • name (String) —

    Required. Redis instance resource name using the form: projects/project_id/ locations/location_id/instances/instance_id`wherelocation_id` refers to a GCP region.

  • 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



1418
1419
1420
1421
1422
1423
1424
1425
1426
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 1418

def get_project_location_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::RedisV1beta1::Instance::Representation
  command.response_class = Google::Apis::RedisV1beta1::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_project_location_instance_auth_string(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::InstanceAuthString

Gets the AUTH string for a Redis instance. If AUTH is not enabled for the instance the response will be empty. This information is not included in the details returned to GetInstance.

Parameters:

  • name (String) —

    Required. Redis instance resource name using the form: projects/project_id/ locations/location_id/instances/instance_id`wherelocation_id` refers to a GCP region.

  • 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



1452
1453
1454
1455
1456
1457
1458
1459
1460
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 1452

def get_project_location_instance_auth_string(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/authString', options)
  command.response_representation = Google::Apis::RedisV1beta1::InstanceAuthString::Representation
  command.response_class = Google::Apis::RedisV1beta1::InstanceAuthString
  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_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::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:

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



1757
1758
1759
1760
1761
1762
1763
1764
1765
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 1757

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

Gets the details of regional certificate authority information for Redis cluster.

Parameters:

  • name (String) —

    Required. Regional certificate authority resource name using the form: projects/project_id/locations/location_id/ sharedRegionalCertificateAuthority where location_id refers to a Google Cloud region.

  • 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



108
109
110
111
112
113
114
115
116
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 108

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

#import_instance(name, import_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Operation

Import a Redis RDB snapshot file from Cloud Storage into a Redis instance. Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters:

  • name (String) —

    Required. Redis instance resource name using the form: projects/project_id/ locations/location_id/instances/instance_id`wherelocation_id` refers to a GCP region.

  • import_instance_request_object (Google::Apis::RedisV1beta1::ImportInstanceRequest) (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



1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 1489

def import_instance(name, import_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:import', options)
  command.request_representation = Google::Apis::RedisV1beta1::ImportInstanceRequest::Representation
  command.request_object = import_instance_request_object
  command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
  command.response_class = Google::Apis::RedisV1beta1::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

#list_project_location_acl_policies(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::ListAclPoliciesResponse

Lists all ACL Policies owned by a project in either the specified location ( region) or all locations. The location should have the following format: * projects/project_id/locations/location_id`Iflocation_idis specified as-` (wildcard), then all regions available to the project are queried, and the results are aggregated.

Parameters:

  • parent (String) —

    Required. The resource name of the cluster location using the form: projects/ project_id/locations/location_id`wherelocation_id` refers to a Google Cloud region.

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

    Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more ACL policies left to be queried. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

    Optional. The next_page_token value returned from a previous ListAclPolicies request, if any.

  • 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



329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 329

def list_project_location_acl_policies(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/aclPolicies', options)
  command.response_representation = Google::Apis::RedisV1beta1::ListAclPoliciesResponse::Representation
  command.response_class = Google::Apis::RedisV1beta1::ListAclPoliciesResponse
  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_backup_collection_backups(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::ListBackupsResponse

Lists all backups owned by a backup collection.

Parameters:

  • parent (String) —

    Required. The resource name of the backupCollection using the form: projects/ project_id/locations/location_id/backupCollections/backup_collection_id``

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

    Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more clusters left to be queried.

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

    Optional. The next_page_token value returned from a previous [ ListBackupCollections] request, if any.

  • 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



598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 598

def list_project_location_backup_collection_backups(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/backups', options)
  command.response_representation = Google::Apis::RedisV1beta1::ListBackupsResponse::Representation
  command.response_class = Google::Apis::RedisV1beta1::ListBackupsResponse
  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_backup_collections(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::ListBackupCollectionsResponse

Lists all backup collections owned by a consumer project in either the specified location (region) or all locations. If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

Parameters:

  • parent (String) —

    Required. The resource name of the backupCollection location using the form: projects/project_id/locations/location_id`wherelocation_id` refers to a Google Cloud region.

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

    Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more clusters left to be queried.

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

    Optional. The next_page_token value returned from a previous [ ListBackupCollections] request, if any.

  • 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



454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 454

def list_project_location_backup_collections(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/backupCollections', options)
  command.response_representation = Google::Apis::RedisV1beta1::ListBackupCollectionsResponse::Representation
  command.response_class = Google::Apis::RedisV1beta1::ListBackupCollectionsResponse
  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_cluster_token_auth_user_auth_tokens(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::ListAuthTokensResponse

Lists all the auth tokens for a specific token auth user.

Parameters:

  • parent (String) —

    Required. The parent resource that this auth token will be listed for. Format: projects/project/locations/location/clusters/cluster/tokenAuthUsers/ token_auth_user

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

    Optional. Expression for filtering results.

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

    Optional. Sort results by a defined order.

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

    Optional. The maximum number of items to return. The maximum value is 1000; values above 1000 will be coerced to 1000. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response' s next_page_token to determine if there are more clusters left to be queried.

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

    Optional. The next_page_token value returned from a previous [ ListTokenAuthUsers] request, if any.

  • 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



1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 1227

def list_project_location_cluster_token_auth_user_auth_tokens(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/authTokens', options)
  command.response_representation = Google::Apis::RedisV1beta1::ListAuthTokensResponse::Representation
  command.response_class = Google::Apis::RedisV1beta1::ListAuthTokensResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.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_cluster_token_auth_users(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::ListTokenAuthUsersResponse

Lists all the token auth users for a token based auth enabled cluster.

Parameters:

  • parent (String) —

    Required. The parent resource that this token based auth user will be listed for. Format: projects/project/locations/location/clusters/cluster

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

    Optional. Expression for filtering results.

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

    Optional. Sort results by a defined order.

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

    Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's The maximum value is 1000; values above 1000 will be coerced to

    1. next_page_token to determine if there are more clusters left to be queried.
  • page_token (String) (defaults to: nil) —

    Optional. The next_page_token value returned from a previous [ ListTokenAuthUsers] request, if any.

  • 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



1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 1114

def list_project_location_cluster_token_auth_users(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/tokenAuthUsers', options)
  command.response_representation = Google::Apis::RedisV1beta1::ListTokenAuthUsersResponse::Representation
  command.response_class = Google::Apis::RedisV1beta1::ListTokenAuthUsersResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.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_clusters(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::ListClustersResponse

Lists all Redis clusters owned by a project in either the specified location ( region) or all locations. The location should have the following format: * projects/project_id/locations/location_id`Iflocation_idis specified as-` (wildcard), then all regions available to the project are queried, and the results are aggregated.

Parameters:

  • parent (String) —

    Required. The resource name of the cluster location using the form: projects/ project_id/locations/location_id`wherelocation_id` refers to a Google Cloud region.

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

    The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response' s next_page_token to determine if there are more clusters left to be queried.

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

    The next_page_token value returned from a previous ListClusters request, if any.

  • 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



872
873
874
875
876
877
878
879
880
881
882
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 872

def list_project_location_clusters(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/clusters', options)
  command.response_representation = Google::Apis::RedisV1beta1::ListClustersResponse::Representation
  command.response_class = Google::Apis::RedisV1beta1::ListClustersResponse
  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_instances(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::ListInstancesResponse

Lists all Redis instances owned by a project in either the specified location ( region) or all locations. The location should have the following format: * projects/project_id/locations/location_id`Iflocation_idis specified as-` (wildcard), then all regions available to the project are queried, and the results are aggregated.

Parameters:

  • parent (String) —

    Required. The resource name of the instance location using the form: projects/ project_id/locations/location_id`wherelocation_id` refers to a GCP region.

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

    The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response' s next_page_token to determine if there are more instances left to be queried.

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

    The next_page_token value returned from a previous ListInstances request, if any.

  • 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



1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 1536

def list_project_location_instances(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/instances', options)
  command.response_representation = Google::Apis::RedisV1beta1::ListInstancesResponse::Representation
  command.response_class = Google::Apis::RedisV1beta1::ListInstancesResponse
  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_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::RedisV1beta1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

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

    The standard list filter.

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

    The standard list page size.

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

    The standard list page token.

  • 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



1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 1802

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::RedisV1beta1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::RedisV1beta1::ListOperationsResponse
  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_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::RedisV1beta1::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



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

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, 'v1beta1/{+name}/locations', options)
  command.response_representation = Google::Apis::RedisV1beta1::ListLocationsResponse::Representation
  command.response_class = Google::Apis::RedisV1beta1::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

#patch_project_location_acl_policy(name, acl_policy_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Operation

Updates the ACL policy. The operation applies the updated ACL policy to all of the linked clusters. If Memorystore can apply the policy to all clusters, then the operation returns a SUCCESS status. If Memorystore can't apply the policy to all clusters, then to ensure eventual consistency, Memorystore uses reconciliation to apply the policy to the failed clusters. Completed longrunning.Operation will contain the new ACL Policy object in the response field.

Parameters:

  • name (String) —

    Identifier. Full resource path of the ACL policy.

  • acl_policy_object (Google::Apis::RedisV1beta1::AclPolicy) (defaults to: nil)
  • request_id (String) (defaults to: nil) —

    Optional. Idempotent request UUID.

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

    Optional. Mask of fields to be updated. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from AclPolicy: * rules

  • 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



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

def patch_project_location_acl_policy(name, acl_policy_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::RedisV1beta1::AclPolicy::Representation
  command.request_object = acl_policy_object
  command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
  command.response_class = Google::Apis::RedisV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_cluster(name, cluster_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Operation

Updates the metadata and configuration of a specific Redis cluster. Completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters:

  • name (String) —

    Required. Identifier. Unique name of the resource in this scope including project and location using the form: projects/project_id/locations/ location_id/clusters/cluster_id``

  • cluster_object (Google::Apis::RedisV1beta1::Cluster) (defaults to: nil)
  • request_id (String) (defaults to: nil) —

    Optional. Idempotent request UUID.

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

    Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Cluster: * size_gb * replica_count * cluster_endpoints

  • 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



916
917
918
919
920
921
922
923
924
925
926
927
928
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 916

def patch_project_location_cluster(name, cluster_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::RedisV1beta1::Cluster::Representation
  command.request_object = cluster_object
  command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
  command.response_class = Google::Apis::RedisV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_instance(name, instance_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Operation

Updates the metadata and configuration of a specific Redis instance. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters:

  • name (String) —

    Required. Unique name of the resource in this scope including project and location using the form: projects/project_id/locations/location_id/ instances/instance_id`` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details.

  • instance_object (Google::Apis::RedisV1beta1::Instance) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Instance: * displayName * labels * memorySizeGb * redisConfig * replica_count

  • 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



1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 1583

def patch_project_location_instance(name, instance_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::RedisV1beta1::Instance::Representation
  command.request_object = instance_object
  command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
  command.response_class = Google::Apis::RedisV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reschedule_cluster_maintenance(name, reschedule_cluster_maintenance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Operation

Reschedules upcoming maintenance event.

Parameters:

  • name (String) —

    Required. Redis Cluster instance resource name using the form: projects/ project_id/locations/location_id/clusters/cluster_id`wherelocation_id` refers to a Google Cloud region.

  • reschedule_cluster_maintenance_request_object (Google::Apis::RedisV1beta1::RescheduleClusterMaintenanceRequest) (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



953
954
955
956
957
958
959
960
961
962
963
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 953

def reschedule_cluster_maintenance(name, reschedule_cluster_maintenance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:rescheduleClusterMaintenance', options)
  command.request_representation = Google::Apis::RedisV1beta1::RescheduleClusterMaintenanceRequest::Representation
  command.request_object = reschedule_cluster_maintenance_request_object
  command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
  command.response_class = Google::Apis::RedisV1beta1::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

#reschedule_instance_maintenance(name, reschedule_maintenance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Operation

Reschedule maintenance for a given instance in a given project and location.

Parameters:

  • name (String) —

    Required. Redis instance resource name using the form: projects/project_id/ locations/location_id/instances/instance_id`wherelocation_id` refers to a GCP region.

  • reschedule_maintenance_request_object (Google::Apis::RedisV1beta1::RescheduleMaintenanceRequest) (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



1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 1619

def reschedule_instance_maintenance(name, reschedule_maintenance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:rescheduleMaintenance', options)
  command.request_representation = Google::Apis::RedisV1beta1::RescheduleMaintenanceRequest::Representation
  command.request_object = reschedule_maintenance_request_object
  command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
  command.response_class = Google::Apis::RedisV1beta1::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

#upgrade_instance(name, upgrade_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RedisV1beta1::Operation

Upgrades Redis instance to the newer Redis version specified in the request.

Parameters:

  • name (String) —

    Required. Redis instance resource name using the form: projects/project_id/ locations/location_id/instances/instance_id`wherelocation_id` refers to a GCP region.

  • upgrade_instance_request_object (Google::Apis::RedisV1beta1::UpgradeInstanceRequest) (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



1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
 
# File 'lib/google/apis/redis_v1beta1/service.rb', line 1654

def upgrade_instance(name, upgrade_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:upgrade', options)
  command.request_representation = Google::Apis::RedisV1beta1::UpgradeInstanceRequest::Representation
  command.request_object = upgrade_instance_request_object
  command.response_representation = Google::Apis::RedisV1beta1::Operation::Representation
  command.response_class = Google::Apis::RedisV1beta1::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