Class CustomContextUpdates (0.27.0)

public final class CustomContextUpdates extends GeneratedMessage implements CustomContextUpdatesOrBuilder

Describes a collection of updates to apply to custom contexts identified by key.

Protobuf type google.cloud.storagebatchoperations.v1.CustomContextUpdates

Static Fields

KEYS_TO_CLEAR_FIELD_NUMBER

public static final int KEYS_TO_CLEAR_FIELD_NUMBER
Field Value
Type Description
int

UPDATES_FIELD_NUMBER

public static final int UPDATES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CustomContextUpdates getDefaultInstance()
Returns
Type Description
CustomContextUpdates

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CustomContextUpdates.Builder newBuilder()
Returns
Type Description
CustomContextUpdates.Builder

newBuilder(CustomContextUpdates prototype)

public static CustomContextUpdates.Builder newBuilder(CustomContextUpdates prototype)
Parameter
Name Description
prototype CustomContextUpdates
Returns
Type Description
CustomContextUpdates.Builder

parseDelimitedFrom(InputStream input)

public static CustomContextUpdates parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomContextUpdates
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomContextUpdates parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomContextUpdates
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CustomContextUpdates parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CustomContextUpdates
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CustomContextUpdates parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomContextUpdates
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CustomContextUpdates parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CustomContextUpdates
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CustomContextUpdates parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomContextUpdates
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CustomContextUpdates parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CustomContextUpdates
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomContextUpdates parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomContextUpdates
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CustomContextUpdates parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomContextUpdates
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomContextUpdates parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomContextUpdates
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CustomContextUpdates parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CustomContextUpdates
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CustomContextUpdates parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomContextUpdates
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CustomContextUpdates> parser()
Returns
Type Description
Parser<CustomContextUpdates>

Methods

containsUpdates(String key)

public boolean containsUpdates(String key)

Optional. Insert or update the existing custom contexts.

map<string, .google.cloud.storagebatchoperations.v1.ObjectCustomContextPayload> updates = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CustomContextUpdates getDefaultInstanceForType()
Returns
Type Description
CustomContextUpdates

getKeysToClear(int index)

public String getKeysToClear(int index)

Optional. Custom contexts to clear by key. A key cannot be present in both updates and keys_to_clear.

repeated string keys_to_clear = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The keysToClear at the given index.

getKeysToClearBytes(int index)

public ByteString getKeysToClearBytes(int index)

Optional. Custom contexts to clear by key. A key cannot be present in both updates and keys_to_clear.

repeated string keys_to_clear = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the keysToClear at the given index.

getKeysToClearCount()

public int getKeysToClearCount()

Optional. Custom contexts to clear by key. A key cannot be present in both updates and keys_to_clear.

repeated string keys_to_clear = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of keysToClear.

getKeysToClearList()

public ProtocolStringList getKeysToClearList()

Optional. Custom contexts to clear by key. A key cannot be present in both updates and keys_to_clear.

repeated string keys_to_clear = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the keysToClear.

getParserForType()

public Parser<CustomContextUpdates> getParserForType()
Returns
Type Description
Parser<CustomContextUpdates>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdates() (deprecated)

public Map<String,ObjectCustomContextPayload> getUpdates()

Use #getUpdatesMap() instead.

Returns
Type Description
Map<String,ObjectCustomContextPayload>

getUpdatesCount()

public int getUpdatesCount()

Optional. Insert or update the existing custom contexts.

map<string, .google.cloud.storagebatchoperations.v1.ObjectCustomContextPayload> updates = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getUpdatesMap()

public Map<String,ObjectCustomContextPayload> getUpdatesMap()

Optional. Insert or update the existing custom contexts.

map<string, .google.cloud.storagebatchoperations.v1.ObjectCustomContextPayload> updates = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,ObjectCustomContextPayload>

getUpdatesOrDefault(String key, ObjectCustomContextPayload defaultValue)

public ObjectCustomContextPayload getUpdatesOrDefault(String key, ObjectCustomContextPayload defaultValue)

Optional. Insert or update the existing custom contexts.

map<string, .google.cloud.storagebatchoperations.v1.ObjectCustomContextPayload> updates = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue ObjectCustomContextPayload
Returns
Type Description
ObjectCustomContextPayload

getUpdatesOrThrow(String key)

public ObjectCustomContextPayload getUpdatesOrThrow(String key)

Optional. Insert or update the existing custom contexts.

map<string, .google.cloud.storagebatchoperations.v1.ObjectCustomContextPayload> updates = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
ObjectCustomContextPayload

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CustomContextUpdates.Builder newBuilderForType()
Returns
Type Description
CustomContextUpdates.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected CustomContextUpdates.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CustomContextUpdates.Builder
Overrides

toBuilder()

public CustomContextUpdates.Builder toBuilder()
Returns
Type Description
CustomContextUpdates.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException