Google Cloud Memorystore for Redis V1 API - Class Google::Cloud::Redis::Cluster::V1::CloudRedisCluster::Rest::ServiceStub (v0.4.1)

Reference documentation and code samples for the Google Cloud Memorystore for Redis V1 API class Google::Cloud::Redis::Cluster::V1::CloudRedisCluster::Rest::ServiceStub.

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

Inherits

Object

Methods

#create_cluster

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

Baseline implementation for the create_cluster REST call

Parameters

request_pb (::Google::Cloud::Redis::Cluster::V1::CreateClusterRequest) — 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_cluster

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

Baseline implementation for the delete_cluster REST call

Parameters

request_pb (::Google::Cloud::Redis::Cluster::V1::DeleteClusterRequest) — 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)

#get_cluster

def get_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Redis::Cluster::V1::Cluster

Baseline implementation for the get_cluster REST call

Parameters

request_pb (::Google::Cloud::Redis::Cluster::V1::GetClusterRequest) — 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::Cluster::V1::Cluster)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Redis::Cluster::V1::Cluster) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#get_cluster_certificate_authority

def get_cluster_certificate_authority(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Redis::Cluster::V1::CertificateAuthority

Baseline implementation for the get_cluster_certificate_authority REST call

Parameters

request_pb (::Google::Cloud::Redis::Cluster::V1::GetClusterCertificateAuthorityRequest) — 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::Cluster::V1::CertificateAuthority)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Redis::Cluster::V1::CertificateAuthority) — 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_clusters

def list_clusters(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Redis::Cluster::V1::ListClustersResponse

Baseline implementation for the list_clusters REST call

Parameters

request_pb (::Google::Cloud::Redis::Cluster::V1::ListClustersRequest) — 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::Cluster::V1::ListClustersResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Redis::Cluster::V1::ListClustersResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#update_cluster

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

Baseline implementation for the update_cluster REST call

Parameters

request_pb (::Google::Cloud::Redis::Cluster::V1::UpdateClusterRequest) — 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)