Class CopyObjectOptions

Options for CopyObject operations.

Inheritance

System.Object

CopyObjectOptions

Inherited Members

System.Object.ToString()

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Cloud.Storage.V1

Assembly: Google.Cloud.Storage.V1.dll

Syntax

public sealed class CopyObjectOptions

Properties

DestinationPredefinedAcl

A predefined set of ACLs for the new object.

Declaration

public PredefinedObjectAcl? DestinationPredefinedAcl { get; set; }

Property Value

Type	Description
System.Nullable<PredefinedObjectAcl>

EncryptionKey

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.

Declaration

public EncryptionKey EncryptionKey { get; set; }

Property Value

Type	Description
EncryptionKey

ExtraMetadata

Additional object metadata for the new object. This can be used to specify the storage class of the new object, the content type etc. If this property is not set, the existing object metadata will be used unchanged.

Declaration

public Object ExtraMetadata { get; set; }

Property Value

Type	Description
Object

IfGenerationMatch

Precondition for copying: the object is only copied if the existing destination object's generation matches the given value.

Declaration

public long? IfGenerationMatch { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>

IfGenerationNotMatch

Precondition for copying: the object is only copied if the existing destination object's generation does not match the given value.

Declaration

public long? IfGenerationNotMatch { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>

IfMetagenerationMatch

Precondition for copying: the object is only copied if the existing destination object's meta-generation matches the given value.

Declaration

public long? IfMetagenerationMatch { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>

IfMetagenerationNotMatch

Precondition for copying: the object is only copied if the existing destination object's meta-generation does not match the given value.

Declaration

public long? IfMetagenerationNotMatch { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>

IfSourceGenerationMatch

Precondition for copying: the object is only copied if the source object's generation matches the given value.

Declaration

public long? IfSourceGenerationMatch { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>

IfSourceGenerationNotMatch

Precondition for copying: the object is only copied if the source object's generation does not match the given value.

Declaration

public long? IfSourceGenerationNotMatch { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>

IfSourceMetagenerationMatch

Precondition for copying: the object is only copied if the source object's meta-generation matches the given value.

Declaration

public long? IfSourceMetagenerationMatch { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>

IfSourceMetagenerationNotMatch

Precondition for copying: the object is only copied if the source object's meta-generation does not match the given value.

Declaration

public long? IfSourceMetagenerationNotMatch { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>

KmsKeyName

The name of the Cloud KMS key to use to encrypt the new object.

Declaration

public string KmsKeyName { get; set; }

Property Value

Type	Description
System.String

Remarks

Currently, either customer-supplied encryption or a Cloud KMS key can be used, but not both. If this property is null and customer-supplied encryption is not being used, the bucket encryption defaults will be used to determine the encryption for the object. If this property is non-null and the client object has a default encryption key, the EncryptionKey property of this options object must be set to None to make the intention clear.

Projection

The projection to retrieve.

Declaration

public Projection? Projection { get; set; }

Property Value

Type	Description
System.Nullable<Projection>

SourceEncryptionKey

The encryption key to use for the source of the copy. If this property is null, the EncryptionKey will be used instead. Use None if the source is not encrypted.

Declaration

public EncryptionKey SourceEncryptionKey { get; set; }

Property Value

Type	Description
EncryptionKey

SourceGeneration

The generation of the object resource to copy. When not set, the latest generation will be copied.

Declaration

public long? SourceGeneration { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>

UserProject

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.

Declaration

public string UserProject { get; set; }

Property Value

Type	Description
System.String