Interface PutMetadataOrBuilder (0.2.0)

public interface PutMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsCustomMetadata(String key)

public abstract boolean containsCustomMetadata(String key)

Optional. Updates objects custom metadata. Adds or sets individual custom metadata key value pairs on objects. Keys that are set with empty custom metadata values will have its value cleared. Existing custom metadata not specified with this flag is not changed. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-metadata

map<string, string> custom_metadata = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getCacheControl()

public abstract String getCacheControl()

Optional. Updates objects Cache-Control fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Additionally, the value for Custom-Time cannot decrease. Refer to documentation in https://cloud.google.com/storage/docs/metadata#caching_data.

optional string cache_control = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The cacheControl.

getCacheControlBytes()

public abstract ByteString getCacheControlBytes()

Optional. Updates objects Cache-Control fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Additionally, the value for Custom-Time cannot decrease. Refer to documentation in https://cloud.google.com/storage/docs/metadata#caching_data.

optional string cache_control = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for cacheControl.

getContentDisposition()

public abstract String getContentDisposition()

Optional. Updates objects Content-Disposition fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer https://cloud.google.com/storage/docs/metadata#content-disposition for additional documentation.

optional string content_disposition = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The contentDisposition.

getContentDispositionBytes()

public abstract ByteString getContentDispositionBytes()

Optional. Updates objects Content-Disposition fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer https://cloud.google.com/storage/docs/metadata#content-disposition for additional documentation.

optional string content_disposition = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for contentDisposition.

getContentEncoding()

public abstract String getContentEncoding()

Optional. Updates objects Content-Encoding fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-encoding.

optional string content_encoding = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The contentEncoding.

getContentEncodingBytes()

public abstract ByteString getContentEncodingBytes()

Optional. Updates objects Content-Encoding fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-encoding.

optional string content_encoding = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for contentEncoding.

getContentLanguage()

public abstract String getContentLanguage()

Optional. Updates objects Content-Language fixed metadata. Refer to ISO 639-1 language codes for typical values of this metadata. Max length 100 characters. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-language.

optional string content_language = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The contentLanguage.

getContentLanguageBytes()

public abstract ByteString getContentLanguageBytes()

Optional. Updates objects Content-Language fixed metadata. Refer to ISO 639-1 language codes for typical values of this metadata. Max length 100 characters. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-language.

optional string content_language = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for contentLanguage.

getContentType()

public abstract String getContentType()

Optional. Updates objects Content-Type fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-type

optional string content_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The contentType.

getContentTypeBytes()

public abstract ByteString getContentTypeBytes()

Optional. Updates objects Content-Type fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-type

optional string content_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for contentType.

getCustomMetadata() (deprecated)

public abstract Map<String,String> getCustomMetadata()
Returns
Type Description
Map<String,String>

getCustomMetadataCount()

public abstract int getCustomMetadataCount()

Optional. Updates objects custom metadata. Adds or sets individual custom metadata key value pairs on objects. Keys that are set with empty custom metadata values will have its value cleared. Existing custom metadata not specified with this flag is not changed. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-metadata

map<string, string> custom_metadata = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getCustomMetadataMap()

public abstract Map<String,String> getCustomMetadataMap()

Optional. Updates objects custom metadata. Adds or sets individual custom metadata key value pairs on objects. Keys that are set with empty custom metadata values will have its value cleared. Existing custom metadata not specified with this flag is not changed. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-metadata

map<string, string> custom_metadata = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getCustomMetadataOrDefault(String key, String defaultValue)

public abstract String getCustomMetadataOrDefault(String key, String defaultValue)

Optional. Updates objects custom metadata. Adds or sets individual custom metadata key value pairs on objects. Keys that are set with empty custom metadata values will have its value cleared. Existing custom metadata not specified with this flag is not changed. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-metadata

map<string, string> custom_metadata = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getCustomMetadataOrThrow(String key)

public abstract String getCustomMetadataOrThrow(String key)

Optional. Updates objects custom metadata. Adds or sets individual custom metadata key value pairs on objects. Keys that are set with empty custom metadata values will have its value cleared. Existing custom metadata not specified with this flag is not changed. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-metadata

map<string, string> custom_metadata = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getCustomTime()

public abstract String getCustomTime()

Optional. Updates objects Custom-Time fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-time.

optional string custom_time = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The customTime.

getCustomTimeBytes()

public abstract ByteString getCustomTimeBytes()

Optional. Updates objects Custom-Time fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-time.

optional string custom_time = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for customTime.

hasCacheControl()

public abstract boolean hasCacheControl()

Optional. Updates objects Cache-Control fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Additionally, the value for Custom-Time cannot decrease. Refer to documentation in https://cloud.google.com/storage/docs/metadata#caching_data.

optional string cache_control = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the cacheControl field is set.

hasContentDisposition()

public abstract boolean hasContentDisposition()

Optional. Updates objects Content-Disposition fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer https://cloud.google.com/storage/docs/metadata#content-disposition for additional documentation.

optional string content_disposition = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the contentDisposition field is set.

hasContentEncoding()

public abstract boolean hasContentEncoding()

Optional. Updates objects Content-Encoding fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-encoding.

optional string content_encoding = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the contentEncoding field is set.

hasContentLanguage()

public abstract boolean hasContentLanguage()

Optional. Updates objects Content-Language fixed metadata. Refer to ISO 639-1 language codes for typical values of this metadata. Max length 100 characters. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-language.

optional string content_language = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the contentLanguage field is set.

hasContentType()

public abstract boolean hasContentType()

Optional. Updates objects Content-Type fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-type

optional string content_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the contentType field is set.

hasCustomTime()

public abstract boolean hasCustomTime()

Optional. Updates objects Custom-Time fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-time.

optional string custom_time = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the customTime field is set.