Reference documentation and code samples for the Memorystore V1BETA API class Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.
REST client for the Memorystore service.
Service describing handlers for resources
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the Memorystore Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all Memorystore clients ::Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.configure do |config| config.timeout = 10.0 end
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the Memorystore Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#create_instance
def create_instance(request, options = nil) -> ::Gapic::Operation
def create_instance(parent: nil, instance_id: nil, instance: nil, request_id: nil) -> ::Gapic::Operation
Creates a new Instance in a given project and location.
def create_instance(request, options = nil) -> ::Gapic::Operation
create_instance
via a request object, either of type
CreateInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Memorystore::V1beta::CreateInstanceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def create_instance(parent: nil, instance_id: nil, instance: nil, request_id: nil) -> ::Gapic::Operation
create_instance
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- parent (::String) — Required. The parent resource where this instance will be created. Format: projects/{project}/locations/{location}
-
instance_id (::String) —
Required. The ID to use for the instance, which will become the final component of the instance's resource name.
This value is subject to the following restrictions:
- Must be 4-63 characters in length
- Must begin with a letter or digit
- Must contain only lowercase letters, digits, and hyphens
- Must not end with a hyphen
- Must be unique within a location
- instance (::Google::Cloud::Memorystore::V1beta::Instance, ::Hash) — Required. The instance to create.
-
request_id (::String) — 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 since 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).
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/memorystore/v1beta" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Memorystore::V1beta::CreateInstanceRequest.new # Call the create_instance method. result = client.create_instance request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#delete_instance
def delete_instance(request, options = nil) -> ::Gapic::Operation
def delete_instance(name: nil, request_id: nil) -> ::Gapic::Operation
Deletes a single Instance.
def delete_instance(request, options = nil) -> ::Gapic::Operation
delete_instance
via a request object, either of type
DeleteInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Memorystore::V1beta::DeleteInstanceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def delete_instance(name: nil, request_id: nil) -> ::Gapic::Operation
delete_instance
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- name (::String) — Required. The name of the instance to delete. Format: projects/{project}/locations/{location}/instances/{instance}
-
request_id (::String) — 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).
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/memorystore/v1beta" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Memorystore::V1beta::DeleteInstanceRequest.new # Call the delete_instance method. result = client.delete_instance request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#get_certificate_authority
def get_certificate_authority(request, options = nil) -> ::Google::Cloud::Memorystore::V1beta::CertificateAuthority
def get_certificate_authority(name: nil) -> ::Google::Cloud::Memorystore::V1beta::CertificateAuthority
Gets details about the certificate authority for an Instance.
def get_certificate_authority(request, options = nil) -> ::Google::Cloud::Memorystore::V1beta::CertificateAuthority
get_certificate_authority
via a request object, either of type
GetCertificateAuthorityRequest or an equivalent Hash.
- request (::Google::Cloud::Memorystore::V1beta::GetCertificateAuthorityRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get_certificate_authority(name: nil) -> ::Google::Cloud::Memorystore::V1beta::CertificateAuthority
get_certificate_authority
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- name (::String) — Required. The name of the certificate authority. Format: projects/{project}/locations/{location}/instances/{instance}/certificateAuthority
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Memorystore::V1beta::CertificateAuthority)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/memorystore/v1beta" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Memorystore::V1beta::GetCertificateAuthorityRequest.new # Call the get_certificate_authority method. result = client.get_certificate_authority request # The returned object is of type Google::Cloud::Memorystore::V1beta::CertificateAuthority. p result
#get_instance
def get_instance(request, options = nil) -> ::Google::Cloud::Memorystore::V1beta::Instance
def get_instance(name: nil) -> ::Google::Cloud::Memorystore::V1beta::Instance
Gets details of a single Instance.
def get_instance(request, options = nil) -> ::Google::Cloud::Memorystore::V1beta::Instance
get_instance
via a request object, either of type
GetInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Memorystore::V1beta::GetInstanceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get_instance(name: nil) -> ::Google::Cloud::Memorystore::V1beta::Instance
get_instance
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- name (::String) — Required. The name of the instance to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Memorystore::V1beta::Instance)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/memorystore/v1beta" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Memorystore::V1beta::GetInstanceRequest.new # Call the get_instance method. result = client.get_instance request # The returned object is of type Google::Cloud::Memorystore::V1beta::Instance. p result
#initialize
def initialize() { |config| ... } -> Client
Create a new Memorystore REST client object.
- (config) — Configure the Memorystore client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.new do |config| config.timeout = 10.0 end
#list_instances
def list_instances(request, options = nil) -> ::Google::Cloud::Memorystore::V1beta::ListInstancesResponse
def list_instances(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Memorystore::V1beta::ListInstancesResponse
Lists Instances in a given project and location.
def list_instances(request, options = nil) -> ::Google::Cloud::Memorystore::V1beta::ListInstancesResponse
list_instances
via a request object, either of type
ListInstancesRequest or an equivalent Hash.
- request (::Google::Cloud::Memorystore::V1beta::ListInstancesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def list_instances(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Memorystore::V1beta::ListInstancesResponse
list_instances
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- parent (::String) — Required. The parent to list instances from. Format: projects/{project}/locations/{location}
- page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
- page_token (::String) — Optional. A token identifying a page of results the server should return.
- filter (::String) — Optional. Expression for filtering results.
- order_by (::String) — Optional. Sort results by a defined order. Supported values: "name", "create_time".
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Memorystore::V1beta::ListInstancesResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/memorystore/v1beta" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Memorystore::V1beta::ListInstancesRequest.new # Call the list_instances method. result = client.list_instances request # The returned object is of type Gapic::PagedEnumerable. You can iterate # over elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Cloud::Memorystore::V1beta::Instance. p item end
#location_client
def location_client() -> Google::Cloud::Location::Locations::Rest::Client
Get the associated client for mix-in of the Locations.
- (Google::Cloud::Location::Locations::Rest::Client)
#logger
def logger() -> Logger
The logger used for request/response debug logging.
- (Logger)
#operations_client
def operations_client() -> ::Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Operations
Get the associated client for long-running operations.
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_instance
def update_instance(request, options = nil) -> ::Gapic::Operation
def update_instance(update_mask: nil, instance: nil, request_id: nil) -> ::Gapic::Operation
Updates the parameters of a single Instance.
def update_instance(request, options = nil) -> ::Gapic::Operation
update_instance
via a request object, either of type
UpdateInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Memorystore::V1beta::UpdateInstanceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def update_instance(update_mask: nil, instance: nil, request_id: nil) -> ::Gapic::Operation
update_instance
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. The list of fields to be updated on the instance. At least one field must be specified.
- instance (::Google::Cloud::Memorystore::V1beta::Instance, ::Hash) — Required. The instance to update.
-
request_id (::String) — 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 since 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).
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/memorystore/v1beta" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Memorystore::V1beta::UpdateInstanceRequest.new # Call the update_instance method. result = client.update_instance request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end