com.google.api.services.storagetransfer.v1.model

Class MetadataOptions

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.storagetransfer.v1.model.MetadataOptions

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class MetadataOptions
extends com.google.api.client.json.GenericJson

Specifies the metadata options for running a transfer.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Storage Transfer API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
MetadataOptions()

Method Summary

Modifier and Type	Method and Description
MetadataOptions	clone()
String	getAcl() Specifies how each object's ACLs should be preserved for transfers between Google Cloud Storage buckets.
String	getGid() Specifies how each file's POSIX group ID (GID) attribute should be handled by the transfer.
String	getKmsKey() Specifies how each object's Cloud KMS customer-managed encryption key (CMEK) is preserved for transfers between Google Cloud Storage buckets.
String	getMode() Specifies how each file's mode attribute should be handled by the transfer.
String	getStorageClass() Specifies the storage class to set on objects being transferred to Google Cloud Storage buckets.
String	getSymlink() Specifies how symlinks should be handled by the transfer.
String	getTemporaryHold() Specifies how each object's temporary hold status should be preserved for transfers between Google Cloud Storage buckets.
String	getTimeCreated() Specifies how each object's `timeCreated` metadata is preserved for transfers.
String	getUid() Specifies how each file's POSIX user ID (UID) attribute should be handled by the transfer.
MetadataOptions	set(String fieldName, Object value)
MetadataOptions	setAcl(String acl) Specifies how each object's ACLs should be preserved for transfers between Google Cloud Storage buckets.
MetadataOptions	setGid(String gid) Specifies how each file's POSIX group ID (GID) attribute should be handled by the transfer.
MetadataOptions	setKmsKey(String kmsKey) Specifies how each object's Cloud KMS customer-managed encryption key (CMEK) is preserved for transfers between Google Cloud Storage buckets.
MetadataOptions	setMode(String mode) Specifies how each file's mode attribute should be handled by the transfer.
MetadataOptions	setStorageClass(String storageClass) Specifies the storage class to set on objects being transferred to Google Cloud Storage buckets.
MetadataOptions	setSymlink(String symlink) Specifies how symlinks should be handled by the transfer.
MetadataOptions	setTemporaryHold(String temporaryHold) Specifies how each object's temporary hold status should be preserved for transfers between Google Cloud Storage buckets.
MetadataOptions	setTimeCreated(String timeCreated) Specifies how each object's `timeCreated` metadata is preserved for transfers.
MetadataOptions	setUid(String uid) Specifies how each file's POSIX user ID (UID) attribute should be handled by the transfer.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

MetadataOptions

public MetadataOptions()

Method Detail

getAcl

public String getAcl()

Specifies how each object's ACLs should be preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as ACL_DESTINATION_BUCKET_DEFAULT.

Returns:

value or null for none

setAcl

public MetadataOptions setAcl(String acl)

Specifies how each object's ACLs should be preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as ACL_DESTINATION_BUCKET_DEFAULT.

Parameters:

acl - acl or null for none

getGid

public String getGid()

Specifies how each file's POSIX group ID (GID) attribute should be handled by the transfer. By default, GID is not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other transfers.

Returns:

value or null for none

setGid

public MetadataOptions setGid(String gid)

Specifies how each file's POSIX group ID (GID) attribute should be handled by the transfer. By default, GID is not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other transfers.

Parameters:

gid - gid or null for none

getKmsKey

public String getKmsKey()

Specifies how each object's Cloud KMS customer-managed encryption key (CMEK) is preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as KMS_KEY_DESTINATION_BUCKET_DEFAULT.

Returns:

value or null for none

setKmsKey

public MetadataOptions setKmsKey(String kmsKey)

Specifies how each object's Cloud KMS customer-managed encryption key (CMEK) is preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as KMS_KEY_DESTINATION_BUCKET_DEFAULT.

Parameters:

kmsKey - kmsKey or null for none

getMode

public String getMode()

Specifies how each file's mode attribute should be handled by the transfer. By default, mode is not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other transfers.

Returns:

value or null for none

setMode

public MetadataOptions setMode(String mode)

Specifies how each file's mode attribute should be handled by the transfer. By default, mode is not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other transfers.

Parameters:

mode - mode or null for none

getStorageClass

public String getStorageClass()

Specifies the storage class to set on objects being transferred to Google Cloud Storage buckets. If unspecified, the default behavior is the same as STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT.

Returns:

value or null for none

setStorageClass

public MetadataOptions setStorageClass(String storageClass)

Specifies the storage class to set on objects being transferred to Google Cloud Storage buckets. If unspecified, the default behavior is the same as STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT.

Parameters:

storageClass - storageClass or null for none

getSymlink

public String getSymlink()

Specifies how symlinks should be handled by the transfer. By default, symlinks are not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other transfers.

Returns:

value or null for none

setSymlink

public MetadataOptions setSymlink(String symlink)

Specifies how symlinks should be handled by the transfer. By default, symlinks are not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other transfers.

Parameters:

symlink - symlink or null for none

getTemporaryHold

public String getTemporaryHold()

Specifies how each object's temporary hold status should be preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as TEMPORARY_HOLD_PRESERVE.

Returns:

value or null for none

setTemporaryHold

public MetadataOptions setTemporaryHold(String temporaryHold)

Specifies how each object's temporary hold status should be preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as TEMPORARY_HOLD_PRESERVE.

Parameters:

temporaryHold - temporaryHold or null for none

getTimeCreated

public String getTimeCreated()

Specifies how each object's `timeCreated` metadata is preserved for transfers. If unspecified, the default behavior is the same as TIME_CREATED_SKIP. This behavior is supported for transfers to Cloud Storage buckets from Cloud Storage, Amazon S3, S3-compatible storage, and Azure sources.

Returns:

value or null for none

setTimeCreated

public MetadataOptions setTimeCreated(String timeCreated)

Specifies how each object's `timeCreated` metadata is preserved for transfers. If unspecified, the default behavior is the same as TIME_CREATED_SKIP. This behavior is supported for transfers to Cloud Storage buckets from Cloud Storage, Amazon S3, S3-compatible storage, and Azure sources.

Parameters:

timeCreated - timeCreated or null for none

getUid

public String getUid()

Specifies how each file's POSIX user ID (UID) attribute should be handled by the transfer. By default, UID is not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other transfers.

Returns:

value or null for none

setUid

public MetadataOptions setUid(String uid)

Specifies how each file's POSIX user ID (UID) attribute should be handled by the transfer. By default, UID is not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other transfers.

Parameters:

uid - uid or null for none

set

public MetadataOptions set(String fieldName,
                           Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public MetadataOptions clone()

Overrides:

clone in class com.google.api.client.json.GenericJson