Reference documentation and code samples for the Cloud Spanner Instance Admin V1 API class Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Rest::ServiceStub.
REST service stub for the InstanceAdmin 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
- request_pb (::Google::Cloud::Spanner::Admin::Instance::V1::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#create_instance_config
def create_instance_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the create_instance_config REST call
- request_pb (::Google::Cloud::Spanner::Admin::Instance::V1::CreateInstanceConfigRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_instance
def delete_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty
Baseline implementation for the delete_instance REST call
- request_pb (::Google::Cloud::Spanner::Admin::Instance::V1::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Protobuf::Empty) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_instance_config
def delete_instance_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty
Baseline implementation for the delete_instance_config REST call
- request_pb (::Google::Cloud::Spanner::Admin::Instance::V1::DeleteInstanceConfigRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Protobuf::Empty) — A result object deserialized from the server's reply
- (::ArgumentError)
#endpoint
def endpoint() -> String
The effective endpoint
- (String)
#get_iam_policy
def get_iam_policy(request_pb, options = nil) { |result, operation| ... } -> ::Google::Iam::V1::Policy
Baseline implementation for the get_iam_policy REST call
- request_pb (::Google::Iam::V1::GetIamPolicyRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Iam::V1::Policy)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Iam::V1::Policy) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_instance
def get_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::Admin::Instance::V1::Instance
Baseline implementation for the get_instance REST call
- request_pb (::Google::Cloud::Spanner::Admin::Instance::V1::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Spanner::Admin::Instance::V1::Instance)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Spanner::Admin::Instance::V1::Instance) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_instance_config
def get_instance_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig
Baseline implementation for the get_instance_config REST call
- request_pb (::Google::Cloud::Spanner::Admin::Instance::V1::GetInstanceConfigRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig) — A result object deserialized from the server's reply
- (::ArgumentError)
#initialize
def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub
- (ServiceStub) — a new instance of ServiceStub
#list_instance_config_operations
def list_instance_config_operations(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigOperationsResponse
Baseline implementation for the list_instance_config_operations REST call
- request_pb (::Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigOperationsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigOperationsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigOperationsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_instance_configs
def list_instance_configs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigsResponse
Baseline implementation for the list_instance_configs REST call
- request_pb (::Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_instances
def list_instances(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::Admin::Instance::V1::ListInstancesResponse
Baseline implementation for the list_instances REST call
- request_pb (::Google::Cloud::Spanner::Admin::Instance::V1::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Spanner::Admin::Instance::V1::ListInstancesResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Spanner::Admin::Instance::V1::ListInstancesResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#set_iam_policy
def set_iam_policy(request_pb, options = nil) { |result, operation| ... } -> ::Google::Iam::V1::Policy
Baseline implementation for the set_iam_policy REST call
- request_pb (::Google::Iam::V1::SetIamPolicyRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Iam::V1::Policy)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Iam::V1::Policy) — A result object deserialized from the server's reply
- (::ArgumentError)
#test_iam_permissions
def test_iam_permissions(request_pb, options = nil) { |result, operation| ... } -> ::Google::Iam::V1::TestIamPermissionsResponse
Baseline implementation for the test_iam_permissions REST call
- request_pb (::Google::Iam::V1::TestIamPermissionsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Iam::V1::TestIamPermissionsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Iam::V1::TestIamPermissionsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_instance
def update_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the update_instance REST call
- request_pb (::Google::Cloud::Spanner::Admin::Instance::V1::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#update_instance_config
def update_instance_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the update_instance_config REST call
- request_pb (::Google::Cloud::Spanner::Admin::Instance::V1::UpdateInstanceConfigRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)