Google Cloud Storage v1 API - Class RestoreObjectOptions (4.10.0)

public sealed class RestoreObjectOptions

Reference documentation and code samples for the Google Cloud Storage v1 API class RestoreObjectOptions.

Options for RestoreObject operations.

Inheritance

object > RestoreObjectOptions

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Storage.V1

Assembly

Google.Cloud.Storage.V1.dll

Properties

CopySourceAcl

public bool? CopySourceAcl { get; set; }

If true, the source object's access controls will be copied to the restored object, unless the bucket has UBLA enabled, in which case the restore operation will fail. Otherwise, the bucket's default object ACL will be used.

Property Value
Type	Description
`bool`

EncryptionKey

public EncryptionKey EncryptionKey { get; set; }

The encryption key to use for this operation. If this property is null, the EncryptionKey will be used instead. Use None to remove encryption headers from this request.

Property Value
Type	Description
`EncryptionKey`

IfGenerationMatch

public long? IfGenerationMatch { get; set; }

Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.

Property Value
Type	Description
`long`

Remarks

Note that the generation value passed to the restore operations (a) specifies the exact generation that should be restored, whereas this value (b) is a constraint on the current generation of the object for the operation to succeed. Effectively, this means restore version (a) if current generation is (b).

IfGenerationNotMatch

public long? IfGenerationNotMatch { get; set; }

Makes the operation conditional on whether the object's live generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.

Property Value
Type	Description
`long`

Remarks

IfMetagenerationMatch

public long? IfMetagenerationMatch { get; set; }

Makes the operation conditional on whether the object's current metageneration matches the given value.

Property Value
Type	Description
`long`

Remarks

Note that the generation value passed to the restore operations (a) specifies the exact generation that should be restored, whereas this value (b) is a constraint on the current metageneration of the object for the operation to succeed. Effectively, this means restore version (a) if current metageneration is (b).

IfMetagenerationNotMatch

public long? IfMetagenerationNotMatch { get; set; }

Makes the operation conditional on whether the object's current metageneration does not match the given value.

Property Value
Type	Description
`long`

Remarks

Projection

public Projection? Projection { get; set; }

The projection of the restored object to return. Note the whole object will be restored, except for the object's access controls, see CopySourceAcl for that. This only affects what information is returned when restoration is successful.

Property Value
Type	Description
`Projection`

RetryOptions

public RetryOptions RetryOptions { get; set; }

Options to pass custom retry configuration for each API request.

Property Value
Type	Description
`RetryOptions`

UserProject

public string UserProject { get; set; }

If set, this is the ID of the project which will be billed for the request. The caller must have suitable permissions for the project being billed.

Property Value
Type	Description
`string`