Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}
×
ExternalBackupService
DeleteExternalBackup
GetExternalBackup
GetExternalBackups
PostExternalBackup
PutExternalBackup
PUT /v1/externalbackups/{id}
PutExternalBackup modifies a given external backup, without using stored credential reconciliation.
TestExternalBackup
TestUpdatedExternalBackup
POST /v1/externalbackups/test/updated
TestUpdatedExternalBackup checks if the given external backup is correctly configured, with optional stored credential reconciliation.
TriggerExternalBackup
UpdateExternalBackup
PATCH /v1/externalbackups/{externalBackup.id}
UpdateExternalBackup modifies a given external backup, with optional stored credential reconciliation.
Common object reference
ProtobufAny
Any contains an arbitrary serialized protocol buffer message along with a
URL that describes the type of the serialized message.
Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
Example 1: Pack and unpack a message in C++.
Example 2: Pack and unpack a message in Java.
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
foo = any.unpack(Foo.getDefaultInstance());
}
Example 3: Pack and unpack a message in Python.
foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
...
}
The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
JSON representation
The JSON representation of an Any value uses the regular
representation of the deserialized, embedded message, with an
additional field @type which contains the type URL. Example:
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
If the embedded message type is well-known and has a custom JSON
representation, that representation will be embedded adding a field
value which holds the custom JSON in addition to the @type
field. Example (for message [google.protobuf.Duration][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
typeUrl |
String |
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in |
|||
value |
byte[] |
Must be a valid serialized protocol buffer of the above specified type. |
byte |
RuntimeError
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
error |
String |
||||
code |
Integer |
int32 |
|||
message |
String |
||||
details |
List of ProtobufAny |
ScheduleDaysOfMonth
1 for 1st, 2 for 2nd .... 31 for 31st
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
days |
List of |
int32 |
ScheduleDaysOfWeek
Sunday = 0, Monday = 1, .... Saturday = 6
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
days |
List of |
int32 |
StorageExternalBackup
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
id |
String |
||||
name |
String |
||||
type |
String |
||||
schedule |
|||||
backupsToKeep |
Integer |
int32 |
|||
s3 |
|||||
gcs |
|||||
includeCertificates |
Boolean |
StorageGCSConfig
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
bucket |
String |
||||
serviceAccount |
String |
The service account for the storage integration. The server will mask the value of this credential in responses and logs. |
|||
objectPrefix |
String |
||||
useWorkloadId |
Boolean |
StorageS3Config
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
bucket |
String |
||||
useIam |
Boolean |
||||
accessKeyId |
String |
The access key ID for the storage integration. The server will mask the value of this credential in responses and logs. |
|||
secretAccessKey |
String |
The secret access key for the storage integration. The server will mask the value of this credential in responses and logs. |
|||
region |
String |
||||
objectPrefix |
String |
||||
endpoint |
String |
StorageSchedule
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
intervalType |
UNSET, DAILY, WEEKLY, MONTHLY, |
||||
hour |
Integer |
int32 |
|||
minute |
Integer |
int32 |
|||
weekly |
|||||
daysOfWeek |
|||||
daysOfMonth |
V1GetExternalBackupsResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
externalBackups |
List of StorageExternalBackup |