Reference documentation and code samples for the AlloyDB V1 API class Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Rest::ServiceStub.
REST service stub for the AlloyDBAdmin service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.
Inherits
- Object
Methods
#batch_create_instances
def batch_create_instances(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the batch_create_instances REST call
- request_pb (::Google::Cloud::AlloyDB::V1::BatchCreateInstancesRequest) — 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_backup
def create_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the create_backup REST call
- request_pb (::Google::Cloud::AlloyDB::V1::CreateBackupRequest) — 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_cluster
def create_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the create_cluster REST call
- request_pb (::Google::Cloud::AlloyDB::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.
- (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
def create_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the create_instance REST call
- request_pb (::Google::Cloud::AlloyDB::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_secondary_cluster
def create_secondary_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the create_secondary_cluster REST call
- request_pb (::Google::Cloud::AlloyDB::V1::CreateSecondaryClusterRequest) — 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_secondary_instance
def create_secondary_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the create_secondary_instance REST call
- request_pb (::Google::Cloud::AlloyDB::V1::CreateSecondaryInstanceRequest) — 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_user
def create_user(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::User
Baseline implementation for the create_user REST call
- request_pb (::Google::Cloud::AlloyDB::V1::CreateUserRequest) — 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::AlloyDB::V1::User)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::AlloyDB::V1::User) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_backup
def delete_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the delete_backup REST call
- request_pb (::Google::Cloud::AlloyDB::V1::DeleteBackupRequest) — 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_cluster
def delete_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the delete_cluster REST call
- request_pb (::Google::Cloud::AlloyDB::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.
- (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::Longrunning::Operation
Baseline implementation for the delete_instance REST call
- request_pb (::Google::Cloud::AlloyDB::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::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_user
def delete_user(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty
Baseline implementation for the delete_user REST call
- request_pb (::Google::Cloud::AlloyDB::V1::DeleteUserRequest) — 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)
#failover_instance
def failover_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the failover_instance REST call
- request_pb (::Google::Cloud::AlloyDB::V1::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.
- (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)
#generate_client_certificate
def generate_client_certificate(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::GenerateClientCertificateResponse
Baseline implementation for the generate_client_certificate REST call
- request_pb (::Google::Cloud::AlloyDB::V1::GenerateClientCertificateRequest) — 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::AlloyDB::V1::GenerateClientCertificateResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::AlloyDB::V1::GenerateClientCertificateResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_backup
def get_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::Backup
Baseline implementation for the get_backup REST call
- request_pb (::Google::Cloud::AlloyDB::V1::GetBackupRequest) — 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::AlloyDB::V1::Backup)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::AlloyDB::V1::Backup) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_cluster
def get_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::Cluster
Baseline implementation for the get_cluster REST call
- request_pb (::Google::Cloud::AlloyDB::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::AlloyDB::V1::Cluster)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::AlloyDB::V1::Cluster) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_connection_info
def get_connection_info(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::ConnectionInfo
Baseline implementation for the get_connection_info REST call
- request_pb (::Google::Cloud::AlloyDB::V1::GetConnectionInfoRequest) — 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::AlloyDB::V1::ConnectionInfo)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::AlloyDB::V1::ConnectionInfo) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_instance
def get_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::Instance
Baseline implementation for the get_instance REST call
- request_pb (::Google::Cloud::AlloyDB::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::AlloyDB::V1::Instance)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::AlloyDB::V1::Instance) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_user
def get_user(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::User
Baseline implementation for the get_user REST call
- request_pb (::Google::Cloud::AlloyDB::V1::GetUserRequest) — 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::AlloyDB::V1::User)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::AlloyDB::V1::User) — 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
#inject_fault
def inject_fault(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the inject_fault REST call
- request_pb (::Google::Cloud::AlloyDB::V1::InjectFaultRequest) — 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)
#list_backups
def list_backups(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::ListBackupsResponse
Baseline implementation for the list_backups REST call
- request_pb (::Google::Cloud::AlloyDB::V1::ListBackupsRequest) — 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::AlloyDB::V1::ListBackupsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::AlloyDB::V1::ListBackupsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_clusters
def list_clusters(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::ListClustersResponse
Baseline implementation for the list_clusters REST call
- request_pb (::Google::Cloud::AlloyDB::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::AlloyDB::V1::ListClustersResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::AlloyDB::V1::ListClustersResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_instances
def list_instances(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::ListInstancesResponse
Baseline implementation for the list_instances REST call
- request_pb (::Google::Cloud::AlloyDB::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::AlloyDB::V1::ListInstancesResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::AlloyDB::V1::ListInstancesResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_supported_database_flags
def list_supported_database_flags(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::ListSupportedDatabaseFlagsResponse
Baseline implementation for the list_supported_database_flags REST call
- request_pb (::Google::Cloud::AlloyDB::V1::ListSupportedDatabaseFlagsRequest) — 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::AlloyDB::V1::ListSupportedDatabaseFlagsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::AlloyDB::V1::ListSupportedDatabaseFlagsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_users
def list_users(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::ListUsersResponse
Baseline implementation for the list_users REST call
- request_pb (::Google::Cloud::AlloyDB::V1::ListUsersRequest) — 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::AlloyDB::V1::ListUsersResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::AlloyDB::V1::ListUsersResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#promote_cluster
def promote_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the promote_cluster REST call
- request_pb (::Google::Cloud::AlloyDB::V1::PromoteClusterRequest) — 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)
#restart_instance
def restart_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the restart_instance REST call
- request_pb (::Google::Cloud::AlloyDB::V1::RestartInstanceRequest) — 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)
#restore_cluster
def restore_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the restore_cluster REST call
- request_pb (::Google::Cloud::AlloyDB::V1::RestoreClusterRequest) — 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)
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_backup
def update_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the update_backup REST call
- request_pb (::Google::Cloud::AlloyDB::V1::UpdateBackupRequest) — 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_cluster
def update_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the update_cluster REST call
- request_pb (::Google::Cloud::AlloyDB::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.
- (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
def update_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the update_instance REST call
- request_pb (::Google::Cloud::AlloyDB::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_user
def update_user(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AlloyDB::V1::User
Baseline implementation for the update_user REST call
- request_pb (::Google::Cloud::AlloyDB::V1::UpdateUserRequest) — 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::AlloyDB::V1::User)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::AlloyDB::V1::User) — A result object deserialized from the server's reply
- (::ArgumentError)