Class ProjectsResource.InstancesResource.BackupsResource.CreateRequest

Starts creating a new Cloud Spanner Backup. The returned backup long-running operation will have a name of the format projects//instances//backups//operations/ and can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Operation>
SpannerBaseServiceRequest<Operation>
ProjectsResource.InstancesResource.BackupsResource.CreateRequest
Implements
Inherited Members
Namespace: Google.Apis.Spanner.v1
Assembly: Google.Apis.Spanner.v1.dll
Syntax
public class ProjectsResource.InstancesResource.BackupsResource.CreateRequest : SpannerBaseServiceRequest<Operation>, IClientServiceRequest<Operation>, IClientServiceRequest

Constructors

CreateRequest(IClientService, Backup, string)

Constructs a new Create request.

Declaration
public CreateRequest(IClientService service, Backup body, string parent)
Parameters
Type Name Description
IClientService service
Backup body
string parent

Properties

BackupId

Required. The id of the backup to be created. The backup_id appended to parent forms the full backup name of the form projects//instances//backups/.

Declaration
[RequestParameter("backupId", RequestParameterType.Query)]
public virtual string BackupId { get; set; }
Property Value
Type Description
string

EncryptionConfigEncryptionType

Required. The encryption type of the backup.

Declaration
[RequestParameter("encryptionConfig.encryptionType", RequestParameterType.Query)]
public virtual ProjectsResource.InstancesResource.BackupsResource.CreateRequest.EncryptionConfigEncryptionTypeEnum? EncryptionConfigEncryptionType { get; set; }
Property Value
Type Description
ProjectsResource.InstancesResource.BackupsResource.CreateRequest.EncryptionConfigEncryptionTypeEnum?

EncryptionConfigKmsKeyName

Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is CUSTOMER_MANAGED_ENCRYPTION. Values are of the form projects//locations//keyRings//cryptoKeys/.

Declaration
[RequestParameter("encryptionConfig.kmsKeyName", RequestParameterType.Query)]
public virtual string EncryptionConfigKmsKeyName { get; set; }
Property Value
Type Description
string

EncryptionConfigKmsKeyNames

Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form projects//locations//keyRings//cryptoKeys/. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type GOOGLE_MANAGED, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type USER_MANAGED, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for USER_MANAGED type instance configurations.

Declaration
[RequestParameter("encryptionConfig.kmsKeyNames", RequestParameterType.Query)]
public virtual Repeatable<string> EncryptionConfigKmsKeyNames { get; set; }
Property Value
Type Description
Repeatable<string>

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Parent

Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form projects//instances/.

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides

InitParameters()

Initializes Create parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements