Google Cloud Memorystore for Redis V1beta1 API - Class Google::Cloud::Redis::V1beta1::CloudRedis::Rest::ServiceStub (v0.13.2)

Version latest

• 0.13.2 (latest)
• 0.13.1
• 0.12.2
• 0.11.0
• 0.10.1
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.1

Reference documentation and code samples for the Google Cloud Memorystore for Redis V1beta1 API class Google::Cloud::Redis::V1beta1::CloudRedis::Rest::ServiceStub.

REST service stub for the CloudRedis service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

• Object

Methods

#create_instance

def create_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_instance REST call

Parameters

• request_pb (::Google::Cloud::Redis::V1beta1::CreateInstanceRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#delete_instance

def delete_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the delete_instance REST call

Parameters

• request_pb (::Google::Cloud::Redis::V1beta1::DeleteInstanceRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

• (String)

#export_instance

def export_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the export_instance REST call

Parameters

• request_pb (::Google::Cloud::Redis::V1beta1::ExportInstanceRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#failover_instance

def failover_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the failover_instance REST call

Parameters

• request_pb (::Google::Cloud::Redis::V1beta1::FailoverInstanceRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_instance

def get_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Redis::V1beta1::Instance

Baseline implementation for the get_instance REST call

Parameters

• request_pb (::Google::Cloud::Redis::V1beta1::GetInstanceRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Redis::V1beta1::Instance)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Redis::V1beta1::Instance) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_instance_auth_string

def get_instance_auth_string(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Redis::V1beta1::InstanceAuthString

Baseline implementation for the get_instance_auth_string REST call

Parameters

• request_pb (::Google::Cloud::Redis::V1beta1::GetInstanceAuthStringRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Redis::V1beta1::InstanceAuthString)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Redis::V1beta1::InstanceAuthString) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#import_instance

def import_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the import_instance REST call

Parameters

• request_pb (::Google::Cloud::Redis::V1beta1::ImportInstanceRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub

Returns

• (ServiceStub) — a new instance of ServiceStub

#list_instances

def list_instances(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Redis::V1beta1::ListInstancesResponse

Baseline implementation for the list_instances REST call

Parameters

• request_pb (::Google::Cloud::Redis::V1beta1::ListInstancesRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Redis::V1beta1::ListInstancesResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Redis::V1beta1::ListInstancesResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#reschedule_maintenance

def reschedule_maintenance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the reschedule_maintenance REST call

Parameters

• request_pb (::Google::Cloud::Redis::V1beta1::RescheduleMaintenanceRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)

#update_instance

def update_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the update_instance REST call

Parameters

• request_pb (::Google::Cloud::Redis::V1beta1::UpdateInstanceRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#upgrade_instance

def upgrade_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the upgrade_instance REST call

Parameters

• request_pb (::Google::Cloud::Redis::V1beta1::UpgradeInstanceRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)