public static final class WriteObjectSpec.Builder extends GeneratedMessageV3.Builder<WriteObjectSpec.Builder> implements WriteObjectSpecOrBuilderDescribes an attempt to insert an object, possibly over multiple requests.
Protobuf type google.storage.v2.WriteObjectSpec
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > WriteObjectSpec.BuilderImplements
WriteObjectSpecOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public WriteObjectSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| WriteObjectSpec.Builder |
build()
public WriteObjectSpec build()| Type | Description |
| WriteObjectSpec |
buildPartial()
public WriteObjectSpec buildPartial()| Type | Description |
| WriteObjectSpec |
clear()
public WriteObjectSpec.Builder clear()| Type | Description |
| WriteObjectSpec.Builder |
clearField(Descriptors.FieldDescriptor field)
public WriteObjectSpec.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| WriteObjectSpec.Builder |
clearIfGenerationMatch()
public WriteObjectSpec.Builder clearIfGenerationMatch()Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
optional int64 if_generation_match = 3;
| Type | Description |
| WriteObjectSpec.Builder | This builder for chaining. |
clearIfGenerationNotMatch()
public WriteObjectSpec.Builder clearIfGenerationNotMatch()Makes the operation conditional on whether the object's live generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
optional int64 if_generation_not_match = 4;
| Type | Description |
| WriteObjectSpec.Builder | This builder for chaining. |
clearIfMetagenerationMatch()
public WriteObjectSpec.Builder clearIfMetagenerationMatch()Makes the operation conditional on whether the object's current metageneration matches the given value.
optional int64 if_metageneration_match = 5;
| Type | Description |
| WriteObjectSpec.Builder | This builder for chaining. |
clearIfMetagenerationNotMatch()
public WriteObjectSpec.Builder clearIfMetagenerationNotMatch()Makes the operation conditional on whether the object's current metageneration does not match the given value.
optional int64 if_metageneration_not_match = 6;
| Type | Description |
| WriteObjectSpec.Builder | This builder for chaining. |
clearObjectSize()
public WriteObjectSpec.Builder clearObjectSize() The expected final object size being uploaded.
If this value is set, closing the stream after writing fewer or more than
object_size bytes will result in an OUT_OF_RANGE error.
This situation is considered a client error, and if such an error occurs
you must start the upload over from scratch, this time sending the correct
number of bytes.
The object_size value is ignored for one-shot (non-resumable) writes.
optional int64 object_size = 8;
| Type | Description |
| WriteObjectSpec.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public WriteObjectSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| WriteObjectSpec.Builder |
clearPredefinedAcl()
public WriteObjectSpec.Builder clearPredefinedAcl()Apply a predefined set of access controls to this object. Valid values are "authenticatedRead", "bucketOwnerFullControl", "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
string predefined_acl = 7;
| Type | Description |
| WriteObjectSpec.Builder | This builder for chaining. |
clearResource()
public WriteObjectSpec.Builder clearResource()Destination object, including its name and its metadata.
.google.storage.v2.Object resource = 1;
| Type | Description |
| WriteObjectSpec.Builder |
clone()
public WriteObjectSpec.Builder clone()| Type | Description |
| WriteObjectSpec.Builder |
getDefaultInstanceForType()
public WriteObjectSpec getDefaultInstanceForType()| Type | Description |
| WriteObjectSpec |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
getIfGenerationMatch()
public long getIfGenerationMatch()Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
optional int64 if_generation_match = 3;
| Type | Description |
| long | The ifGenerationMatch. |
getIfGenerationNotMatch()
public long getIfGenerationNotMatch()Makes the operation conditional on whether the object's live generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
optional int64 if_generation_not_match = 4;
| Type | Description |
| long | The ifGenerationNotMatch. |
getIfMetagenerationMatch()
public long getIfMetagenerationMatch()Makes the operation conditional on whether the object's current metageneration matches the given value.
optional int64 if_metageneration_match = 5;
| Type | Description |
| long | The ifMetagenerationMatch. |
getIfMetagenerationNotMatch()
public long getIfMetagenerationNotMatch()Makes the operation conditional on whether the object's current metageneration does not match the given value.
optional int64 if_metageneration_not_match = 6;
| Type | Description |
| long | The ifMetagenerationNotMatch. |
getObjectSize()
public long getObjectSize() The expected final object size being uploaded.
If this value is set, closing the stream after writing fewer or more than
object_size bytes will result in an OUT_OF_RANGE error.
This situation is considered a client error, and if such an error occurs
you must start the upload over from scratch, this time sending the correct
number of bytes.
The object_size value is ignored for one-shot (non-resumable) writes.
optional int64 object_size = 8;
| Type | Description |
| long | The objectSize. |
getPredefinedAcl()
public String getPredefinedAcl()Apply a predefined set of access controls to this object. Valid values are "authenticatedRead", "bucketOwnerFullControl", "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
string predefined_acl = 7;
| Type | Description |
| String | The predefinedAcl. |
getPredefinedAclBytes()
public ByteString getPredefinedAclBytes()Apply a predefined set of access controls to this object. Valid values are "authenticatedRead", "bucketOwnerFullControl", "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
string predefined_acl = 7;
| Type | Description |
| ByteString | The bytes for predefinedAcl. |
getResource()
public Object getResource()Destination object, including its name and its metadata.
.google.storage.v2.Object resource = 1;
| Type | Description |
| Object | The resource. |
getResourceBuilder()
public Object.Builder getResourceBuilder()Destination object, including its name and its metadata.
.google.storage.v2.Object resource = 1;
| Type | Description |
| Object.Builder |
getResourceOrBuilder()
public ObjectOrBuilder getResourceOrBuilder()Destination object, including its name and its metadata.
.google.storage.v2.Object resource = 1;
| Type | Description |
| ObjectOrBuilder |
hasIfGenerationMatch()
public boolean hasIfGenerationMatch()Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
optional int64 if_generation_match = 3;
| Type | Description |
| boolean | Whether the ifGenerationMatch field is set. |
hasIfGenerationNotMatch()
public boolean hasIfGenerationNotMatch()Makes the operation conditional on whether the object's live generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
optional int64 if_generation_not_match = 4;
| Type | Description |
| boolean | Whether the ifGenerationNotMatch field is set. |
hasIfMetagenerationMatch()
public boolean hasIfMetagenerationMatch()Makes the operation conditional on whether the object's current metageneration matches the given value.
optional int64 if_metageneration_match = 5;
| Type | Description |
| boolean | Whether the ifMetagenerationMatch field is set. |
hasIfMetagenerationNotMatch()
public boolean hasIfMetagenerationNotMatch()Makes the operation conditional on whether the object's current metageneration does not match the given value.
optional int64 if_metageneration_not_match = 6;
| Type | Description |
| boolean | Whether the ifMetagenerationNotMatch field is set. |
hasObjectSize()
public boolean hasObjectSize() The expected final object size being uploaded.
If this value is set, closing the stream after writing fewer or more than
object_size bytes will result in an OUT_OF_RANGE error.
This situation is considered a client error, and if such an error occurs
you must start the upload over from scratch, this time sending the correct
number of bytes.
The object_size value is ignored for one-shot (non-resumable) writes.
optional int64 object_size = 8;
| Type | Description |
| boolean | Whether the objectSize field is set. |
hasResource()
public boolean hasResource()Destination object, including its name and its metadata.
.google.storage.v2.Object resource = 1;
| Type | Description |
| boolean | Whether the resource field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public WriteObjectSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| WriteObjectSpec.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public WriteObjectSpec.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| WriteObjectSpec.Builder |
mergeFrom(WriteObjectSpec other)
public WriteObjectSpec.Builder mergeFrom(WriteObjectSpec other)| Name | Description |
| other | WriteObjectSpec |
| Type | Description |
| WriteObjectSpec.Builder |
mergeResource(Object value)
public WriteObjectSpec.Builder mergeResource(Object value)Destination object, including its name and its metadata.
.google.storage.v2.Object resource = 1;
| Name | Description |
| value | Object |
| Type | Description |
| WriteObjectSpec.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final WriteObjectSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| WriteObjectSpec.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public WriteObjectSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| WriteObjectSpec.Builder |
setIfGenerationMatch(long value)
public WriteObjectSpec.Builder setIfGenerationMatch(long value)Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
optional int64 if_generation_match = 3;
| Name | Description |
| value | longThe ifGenerationMatch to set. |
| Type | Description |
| WriteObjectSpec.Builder | This builder for chaining. |
setIfGenerationNotMatch(long value)
public WriteObjectSpec.Builder setIfGenerationNotMatch(long value)Makes the operation conditional on whether the object's live generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
optional int64 if_generation_not_match = 4;
| Name | Description |
| value | longThe ifGenerationNotMatch to set. |
| Type | Description |
| WriteObjectSpec.Builder | This builder for chaining. |
setIfMetagenerationMatch(long value)
public WriteObjectSpec.Builder setIfMetagenerationMatch(long value)Makes the operation conditional on whether the object's current metageneration matches the given value.
optional int64 if_metageneration_match = 5;
| Name | Description |
| value | longThe ifMetagenerationMatch to set. |
| Type | Description |
| WriteObjectSpec.Builder | This builder for chaining. |
setIfMetagenerationNotMatch(long value)
public WriteObjectSpec.Builder setIfMetagenerationNotMatch(long value)Makes the operation conditional on whether the object's current metageneration does not match the given value.
optional int64 if_metageneration_not_match = 6;
| Name | Description |
| value | longThe ifMetagenerationNotMatch to set. |
| Type | Description |
| WriteObjectSpec.Builder | This builder for chaining. |
setObjectSize(long value)
public WriteObjectSpec.Builder setObjectSize(long value) The expected final object size being uploaded.
If this value is set, closing the stream after writing fewer or more than
object_size bytes will result in an OUT_OF_RANGE error.
This situation is considered a client error, and if such an error occurs
you must start the upload over from scratch, this time sending the correct
number of bytes.
The object_size value is ignored for one-shot (non-resumable) writes.
optional int64 object_size = 8;
| Name | Description |
| value | longThe objectSize to set. |
| Type | Description |
| WriteObjectSpec.Builder | This builder for chaining. |
setPredefinedAcl(String value)
public WriteObjectSpec.Builder setPredefinedAcl(String value)Apply a predefined set of access controls to this object. Valid values are "authenticatedRead", "bucketOwnerFullControl", "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
string predefined_acl = 7;
| Name | Description |
| value | StringThe predefinedAcl to set. |
| Type | Description |
| WriteObjectSpec.Builder | This builder for chaining. |
setPredefinedAclBytes(ByteString value)
public WriteObjectSpec.Builder setPredefinedAclBytes(ByteString value)Apply a predefined set of access controls to this object. Valid values are "authenticatedRead", "bucketOwnerFullControl", "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
string predefined_acl = 7;
| Name | Description |
| value | ByteStringThe bytes for predefinedAcl to set. |
| Type | Description |
| WriteObjectSpec.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public WriteObjectSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| WriteObjectSpec.Builder |
setResource(Object value)
public WriteObjectSpec.Builder setResource(Object value)Destination object, including its name and its metadata.
.google.storage.v2.Object resource = 1;
| Name | Description |
| value | Object |
| Type | Description |
| WriteObjectSpec.Builder |
setResource(Object.Builder builderForValue)
public WriteObjectSpec.Builder setResource(Object.Builder builderForValue)Destination object, including its name and its metadata.
.google.storage.v2.Object resource = 1;
| Name | Description |
| builderForValue | Object.Builder |
| Type | Description |
| WriteObjectSpec.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final WriteObjectSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| WriteObjectSpec.Builder |