Class RewriteObject.Builder (0.16.0)
public static final class RewriteObject.Builder extends GeneratedMessageV3.Builder<RewriteObject.Builder> implements RewriteObjectOrBuilder
Describes options for object rewrite.
Protobuf type google.cloud.storagebatchoperations.v1.RewriteObject
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RewriteObject.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public RewriteObject build()
buildPartial()
public RewriteObject buildPartial()
clear()
public RewriteObject.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public RewriteObject.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearKmsKey()
public RewriteObject.Builder clearKmsKey()
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) = { ... }
clearOneof(Descriptors.OneofDescriptor oneof)
public RewriteObject.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clone()
public RewriteObject.Builder clone()
Overrides
getDefaultInstanceForType()
public RewriteObject getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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.
|
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.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(RewriteObject other)
public RewriteObject.Builder mergeFrom(RewriteObject other)
public RewriteObject.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public RewriteObject.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RewriteObject.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public RewriteObject.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setKmsKey(String value)
public RewriteObject.Builder setKmsKey(String value)
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) = { ... }
| Parameter |
| Name |
Description |
value |
String
The kmsKey to set.
|
setKmsKeyBytes(ByteString value)
public RewriteObject.Builder setKmsKeyBytes(ByteString value)
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) = { ... }
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for kmsKey to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RewriteObject.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final RewriteObject.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-11 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]
