@ -1,4 +1,4 @@
/ / Copyright 2022 Google LLC
/ / Copyright 2023 Google LLC
/ /
/ / Licensed under the Apache License , Version 2.0 ( the "License" ) ;
/ / you may not use this file except in compliance with the License.
@ -98,6 +98,23 @@ service AlloyDBAdmin {
} ;
}
/ / Promotes a SECONDARY cluster. This turns down replication
/ / from the PRIMARY cluster and promotes a secondary cluster
/ / into its own standalone cluster.
/ / Imperative only.
rpc PromoteCluster ( PromoteClusterRequest )
returns ( google.longrunning.Operation ) {
option ( google.api.http ) = {
post : "/v1/{name=projects/*/locations/*/clusters/*}:promote"
body : "*"
} ;
option ( google.api.method_signature ) = "name" ;
option ( google.longrunning.operation_info ) = {
response_type : "Cluster"
metadata_type : "OperationMetadata"
} ;
}
/ / Creates a new Cluster in a given project and location , with a volume
/ / restored from the provided source , either a backup ID or a point - in - time
/ / and a source cluster.
@ -113,6 +130,21 @@ service AlloyDBAdmin {
} ;
}
/ / Creates a cluster of type SECONDARY in the given location using
/ / the primary cluster as the source.
rpc CreateSecondaryCluster ( CreateSecondaryClusterRequest )
returns ( google.longrunning.Operation ) {
option ( google.api.http ) = {
post : "/v1/{parent=projects/*/locations/*}/clusters:createsecondary"
body : "cluster"
} ;
option ( google.api.method_signature ) = "parent,cluster,cluster_id" ;
option ( google.longrunning.operation_info ) = {
response_type : "Cluster"
metadata_type : "OperationMetadata"
} ;
}
/ / Lists Instances in a given project and location.
rpc ListInstances ( ListInstancesRequest ) returns ( ListInstancesResponse ) {
option ( google.api.http ) = {
@ -143,6 +175,20 @@ service AlloyDBAdmin {
} ;
}
/ / Creates a new SECONDARY Instance in a given project and location.
rpc CreateSecondaryInstance ( CreateSecondaryInstanceRequest )
returns ( google.longrunning.Operation ) {
option ( google.api.http ) = {
post : "/v1/{parent=projects/*/locations/*/clusters/*}/instances:createsecondary"
body : "instance"
} ;
option ( google.api.method_signature ) = "parent,instance,instance_id" ;
option ( google.longrunning.operation_info ) = {
response_type : "Instance"
metadata_type : "OperationMetadata"
} ;
}
/ / Creates new instances under the given project , location and cluster.
/ / There can be only one primary instance in a cluster. If the primary
/ / instance exists in the cluster as well as this request , then API will
@ -208,6 +254,20 @@ service AlloyDBAdmin {
} ;
}
/ / Injects fault in an instance.
/ / Imperative only.
rpc InjectFault ( InjectFaultRequest ) returns ( google.longrunning.Operation ) {
option ( google.api.http ) = {
post : "/v1/{name=projects/*/locations/*/clusters/*/instances/*}:injectFault"
body : "*"
} ;
option ( google.api.method_signature ) = "fault_type,name" ;
option ( google.longrunning.operation_info ) = {
response_type : "Instance"
metadata_type : "OperationMetadata"
} ;
}
/ / Restart an Instance in a cluster.
/ / Imperative only.
rpc RestartInstance ( RestartInstanceRequest )
@ -285,6 +345,48 @@ service AlloyDBAdmin {
} ;
option ( google.api.method_signature ) = "parent" ;
}
/ / Lists Users in a given project and location.
rpc ListUsers ( ListUsersRequest ) returns ( ListUsersResponse ) {
option ( google.api.http ) = {
get : "/v1/{parent=projects/*/locations/*/clusters/*}/users"
} ;
option ( google.api.method_signature ) = "parent" ;
}
/ / Gets details of a single User.
rpc GetUser ( GetUserRequest ) returns ( User ) {
option ( google.api.http ) = {
get : "/v1/{name=projects/*/locations/*/clusters/*/users/*}"
} ;
option ( google.api.method_signature ) = "name" ;
}
/ / Creates a new User in a given project , location , and cluster.
rpc CreateUser ( CreateUserRequest ) returns ( User ) {
option ( google.api.http ) = {
post : "/v1/{parent=projects/*/locations/*/clusters/*}/users"
body : "user"
} ;
option ( google.api.method_signature ) = "parent,user,user_id" ;
}
/ / Updates the parameters of a single User.
rpc UpdateUser ( UpdateUserRequest ) returns ( User ) {
option ( google.api.http ) = {
patch : "/v1/{user.name=projects/*/locations/*/clusters/*/users/*}"
body : "user"
} ;
option ( google.api.method_signature ) = "user,update_mask" ;
}
/ / Deletes a single User.
rpc DeleteUser ( DeleteUserRequest ) returns ( google.protobuf.Empty ) {
option ( google.api.http ) = {
delete : "/v1/{name=projects/*/locations/*/clusters/*/users/*}"
} ;
option ( google.api.method_signature ) = "name" ;
}
}
/ / Message for requesting list of Clusters
@ -334,11 +436,52 @@ message GetClusterRequest {
( google.api.field_behavior ) = REQUIRED ,
( google.api.resource_reference ) = { type : "alloydb.googleapis.com/Cluster" }
] ;
/ / Optional. The view of the cluster to return. Returns all default fields if
/ / not set.
ClusterView view = 2 [ ( google.api.field_behavior ) = OPTIONAL ] ;
}
message CreateSecondaryClusterRequest {
/ / Required. The location of the new cluster. For the required
/ / format , see the comment on the Cluster.name field.
string parent = 1 [
( google.api.field_behavior ) = REQUIRED ,
( google.api.resource_reference ) = {
child_type : "alloydb.googleapis.com/Cluster"
}
] ;
/ / Required. ID of the requesting object ( the secondary cluster ) .
string cluster_id = 2 [ ( google.api.field_behavior ) = REQUIRED ] ;
/ / Required. Configuration of the requesting object ( the secondary cluster ) .
Cluster cluster = 3 [ ( google.api.field_behavior ) = REQUIRED ] ;
/ / 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 ) .
string request_id = 5 [ ( google.api.field_behavior ) = OPTIONAL ] ;
/ / Optional. If set , performs request validation ( e.g. permission checks and
/ / any other type of validation ) , but do not actually execute the create
/ / request.
bool validate_only = 6 [ ( google.api.field_behavior ) = OPTIONAL ] ;
}
/ / Message for creating a Cluster
message CreateClusterRequest {
/ / Required. The name of the parent resource. For the required format , see the
/ / Required. The location of the new cluster .For the required format , see the
/ / comment on the Cluster.name field.
string parent = 1 [
( google.api.field_behavior ) = REQUIRED ,
@ -449,6 +592,40 @@ message DeleteClusterRequest {
bool force = 5 [ ( google.api.field_behavior ) = OPTIONAL ] ;
}
/ / Message for promoting a Cluster
message PromoteClusterRequest {
/ / Required. The name of the resource. For the required format , see the
/ / comment on the Cluster.name field
string name = 1 [
( google.api.field_behavior ) = REQUIRED ,
( google.api.resource_reference ) = { type : "alloydb.googleapis.com/Cluster" }
] ;
/ / 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 ) .
string request_id = 2 [ ( google.api.field_behavior ) = OPTIONAL ] ;
/ / Optional. The current etag of the Cluster.
/ / If an etag is provided and does not match the current etag of the Cluster ,
/ / deletion will be blocked and an ABORTED error will be returned.
string etag = 3 [ ( google.api.field_behavior ) = OPTIONAL ] ;
/ / Optional. If set , performs request validation ( e.g. permission checks and
/ / any other type of validation ) , but do not actually execute the delete.
bool validate_only = 4 [ ( google.api.field_behavior ) = OPTIONAL ] ;
}
/ / Message for restoring a Cluster from a backup or another cluster at a given
/ / point in time.
message RestoreClusterRequest {
@ -457,6 +634,10 @@ message RestoreClusterRequest {
oneof source {
/ / Backup source.
BackupSource backup_source = 4 ;
/ / ContinuousBackup source. Continuous backup needs to be enabled in the
/ / source cluster for this operation to succeed.
ContinuousBackupSource continuous_backup_source = 8 ;
}
/ / Required. The name of the parent resource. For the required format , see the
@ -589,6 +770,44 @@ message CreateInstanceRequest {
bool validate_only = 5 [ ( google.api.field_behavior ) = OPTIONAL ] ;
}
/ / Message for creating a Secondary Instance
message CreateSecondaryInstanceRequest {
/ / Required. The name of the parent resource. For the required format , see the
/ / comment on the Instance.name field.
string parent = 1 [
( google.api.field_behavior ) = REQUIRED ,
( google.api.resource_reference ) = {
child_type : "alloydb.googleapis.com/Instance"
}
] ;
/ / Required. ID of the requesting object.
string instance_id = 2 [ ( google.api.field_behavior ) = REQUIRED ] ;
/ / Required. The resource being created
Instance instance = 3 [ ( google.api.field_behavior ) = REQUIRED ] ;
/ / 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 ) .
string request_id = 4 [ ( google.api.field_behavior ) = OPTIONAL ] ;
/ / Optional. If set , performs request validation ( e.g. permission checks and
/ / any other type of validation ) , but do not actually execute the create
/ / request.
bool validate_only = 5 [ ( google.api.field_behavior ) = OPTIONAL ] ;
}
/ / See usage below for notes.
message CreateInstanceRequests {
/ / Required. Primary and read replica instances to be created. This list
@ -633,6 +852,7 @@ message BatchCreateInstancesResponse {
}
/ / Message for metadata that is specific to BatchCreateInstances API.
/ / NEXT_ID : 3
message BatchCreateInstancesMetadata {
/ / The instances being created in the API call. Each string in this list
/ / is the server defined resource path for target instances in the request
@ -660,6 +880,7 @@ message BatchCreateInstancesMetadata {
/ / 2. Instance2 = ROLLED_BACK
/ / 3. Instance3 = FAILED
/ / 4. Instance4 = FAILED
/ /
/ / However , while the operation is running , the instance might be in other
/ / states including PENDING_CREATE , ACTIVE , DELETING and CREATING. The states
/ / / do not get further updated once the operation is done.
@ -819,6 +1040,51 @@ message FailoverInstanceRequest {
bool validate_only = 3 [ ( google.api.field_behavior ) = OPTIONAL ] ;
}
/ / Message for triggering fault injection on an instance
message InjectFaultRequest {
/ / FaultType contains all valid types of faults that can be injected to an
/ / instance.
enum FaultType {
/ / The fault type is unknown.
FAULT_TYPE_UNSPECIFIED = 0 ;
/ / Stop the VM
STOP_VM = 1 ;
}
/ / Required. The type of fault to be injected in an instance.
FaultType fault_type = 1 [ ( google.api.field_behavior ) = REQUIRED ] ;
/ / Required. The name of the resource. For the required format , see the
/ / comment on the Instance.name field.
string name = 2 [
( google.api.field_behavior ) = REQUIRED ,
( google.api.resource_reference ) = {
type : "alloydb.googleapis.com/Instance"
}
] ;
/ / 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 ) .
string request_id = 3 [ ( google.api.field_behavior ) = OPTIONAL ] ;
/ / Optional. If set , performs request validation ( e.g. permission checks and
/ / any other type of validation ) , but do not actually execute the fault
/ / injection.
bool validate_only = 4 [ ( google.api.field_behavior ) = OPTIONAL ] ;
}
message RestartInstanceRequest {
/ / Required. The name of the resource. For the required format , see the
/ / comment on the Instance.name field.
@ -1070,3 +1336,150 @@ message OperationMetadata {
/ / Output only. API version used to start the operation.
string api_version = 7 [ ( google.api.field_behavior ) = OUTPUT_ONLY ] ;
}
/ / Message for requesting list of Users
message ListUsersRequest {
/ / Required. Parent value for ListUsersRequest
string parent = 1 [
( google.api.field_behavior ) = REQUIRED ,
( google.api.resource_reference ) = {
child_type : "alloydb.googleapis.com/User"
}
] ;
/ / Optional. Requested page size. Server may return fewer items than
/ / requested. If unspecified , server will pick an appropriate default .
int32 page_size = 2 [ ( google.api.field_behavior ) = OPTIONAL ] ;
/ / Optional. A token identifying a page of results the server should return.
string page_token = 3 [ ( google.api.field_behavior ) = OPTIONAL ] ;
/ / Optional. Filtering results
string filter = 4 [ ( google.api.field_behavior ) = OPTIONAL ] ;
/ / Optional. Hint for how to order the results
string order_by = 5 [ ( google.api.field_behavior ) = OPTIONAL ] ;
}
/ / Message for response to listing Users
message ListUsersResponse {
/ / The list of User
repeated User users = 1 ;
/ / A token identifying a page of results the server should return.
string next_page_token = 2 ;
/ / Locations that could not be reached.
repeated string unreachable = 3 ;
}
/ / Message for getting a User
message GetUserRequest {
/ / Required. The name of the resource. For the required format , see the
/ / comment on the User.name field.
string name = 1 [
( google.api.field_behavior ) = REQUIRED ,
( google.api.resource_reference ) = { type : "alloydb.googleapis.com/User" }
] ;
}
/ / Message for creating a User
message CreateUserRequest {
/ / Required. Value for parent.
string parent = 1 [
( google.api.field_behavior ) = REQUIRED ,
( google.api.resource_reference ) = {
child_type : "alloydb.googleapis.com/User"
}
] ;
/ / Required. ID of the requesting object.
string user_id = 2 [ ( google.api.field_behavior ) = REQUIRED ] ;
/ / Required. The resource being created
User user = 3 [ ( google.api.field_behavior ) = REQUIRED ] ;
/ / 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 ) .
string request_id = 4 [ ( google.api.field_behavior ) = OPTIONAL ] ;
/ / Optional. If set , the backend validates the request , but doesn ' t actually
/ / execute it.
bool validate_only = 5 [ ( google.api.field_behavior ) = OPTIONAL ] ;
}
/ / Message for updating a User
message UpdateUserRequest {
/ / Optional. Field mask is used to specify the fields to be overwritten in the
/ / User resource by the update.
/ / The fields specified in the update_mask are relative to the resource , not
/ / the full request. A field will be overwritten if it is in the mask. If the
/ / user does not provide a mask then all fields will be overwritten.
google.protobuf.FieldMask update_mask = 1
[ ( google.api.field_behavior ) = OPTIONAL ] ;
/ / Required. The resource being updated
User user = 2 [ ( google.api.field_behavior ) = REQUIRED ] ;
/ / 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 ) .
string request_id = 3 [ ( google.api.field_behavior ) = OPTIONAL ] ;
/ / Optional. If set , the backend validates the request , but doesn ' t actually
/ / execute it.
bool validate_only = 4 [ ( google.api.field_behavior ) = OPTIONAL ] ;
/ / Optional. Allow missing fields in the update mask.
bool allow_missing = 5 [ ( google.api.field_behavior ) = OPTIONAL ] ;
}
/ / Message for deleting a User
message DeleteUserRequest {
/ / Required. The name of the resource. For the required format , see the
/ / comment on the User.name field.
string name = 1 [
( google.api.field_behavior ) = REQUIRED ,
( google.api.resource_reference ) = { type : "alloydb.googleapis.com/User" }
] ;
/ / 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 ) .
string request_id = 2 [ ( google.api.field_behavior ) = OPTIONAL ] ;
/ / Optional. If set , the backend validates the request , but doesn ' t actually
/ / execute it.
bool validate_only = 3 [ ( google.api.field_behavior ) = OPTIONAL ] ;
}
Google APIs
2 years ago
committed by
Copybara-Service