Class RewriteObject (0.2.0)

public final class RewriteObject extends GeneratedMessageV3 implements RewriteObjectOrBuilder

Describes options for object rewrite.

Protobuf type google.cloud.storagebatchoperations.v1.RewriteObject

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

KMS_KEY_FIELD_NUMBER

public static final int KMS_KEY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RewriteObject getDefaultInstance()
Returns
Type Description
RewriteObject

getDescriptor()

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

newBuilder()

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

newBuilder(RewriteObject prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public RewriteObject getDefaultInstanceForType()
Returns
Type Description
RewriteObject

getKmsKey()

public String getKmsKey()

Required. Resource name of the Cloud KMS key that will be used to encrypt the object. The Cloud KMS key must be located in same location as the object. Refer to https://cloud.google.com/storage/docs/encryption/using-customer-managed-keys#add-object-key for additional documentation. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key} For example: "projects/123456/locations/us-central1/keyRings/my-keyring/cryptoKeys/my-key". The object will be rewritten and set with the specified KMS key.

optional string kms_key = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The kmsKey.

getKmsKeyBytes()

public ByteString getKmsKeyBytes()

Required. Resource name of the Cloud KMS key that will be used to encrypt the object. The Cloud KMS key must be located in same location as the object. Refer to https://cloud.google.com/storage/docs/encryption/using-customer-managed-keys#add-object-key for additional documentation. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key} For example: "projects/123456/locations/us-central1/keyRings/my-keyring/cryptoKeys/my-key". The object will be rewritten and set with the specified KMS key.

optional string kms_key = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for kmsKey.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasKmsKey()

public boolean hasKmsKey()

Required. Resource name of the Cloud KMS key that will be used to encrypt the object. The Cloud KMS key must be located in same location as the object. Refer to https://cloud.google.com/storage/docs/encryption/using-customer-managed-keys#add-object-key for additional documentation. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key} For example: "projects/123456/locations/us-central1/keyRings/my-keyring/cryptoKeys/my-key". The object will be rewritten and set with the specified KMS key.

optional string kms_key = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the kmsKey field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RewriteObject.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RewriteObject.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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