Package com.google.storage.v2

Class WriteObjectSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.storage.v2.WriteObjectSpec
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, WriteObjectSpecOrBuilder, Serializable
public final class WriteObjectSpec extends com.google.protobuf.GeneratedMessageV3 implements WriteObjectSpecOrBuilder
 Describes an attempt to insert an object, possibly over multiple requests.
Protobuf type google.storage.v2.WriteObjectSpec
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    WriteObjectSpec.Builder
    Describes an attempt to insert an object, possibly over multiple requests.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    IF_GENERATION_MATCH_FIELD_NUMBER
     
    static final int
    IF_GENERATION_NOT_MATCH_FIELD_NUMBER
     
    static final int
    IF_METAGENERATION_MATCH_FIELD_NUMBER
     
    static final int
    IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER
     
    static final int
    OBJECT_SIZE_FIELD_NUMBER
     
    static final int
    PREDEFINED_ACL_FIELD_NUMBER
     
    static final int
    RESOURCE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static WriteObjectSpec
    getDefaultInstance()
     
    WriteObjectSpec
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    long
    getIfGenerationMatch()
    Makes the operation conditional on whether the object's current generation matches the given value.
    long
    getIfGenerationNotMatch()
    Makes the operation conditional on whether the object's live generation does not match the given value.
    long
    getIfMetagenerationMatch()
    Makes the operation conditional on whether the object's current metageneration matches the given value.
    long
    getIfMetagenerationNotMatch()
    Makes the operation conditional on whether the object's current metageneration does not match the given value.
    long
    getObjectSize()
    The expected final object size being uploaded.
    com.google.protobuf.Parser<WriteObjectSpec>
    getParserForType()
     
    String
    getPredefinedAcl()
    Apply a predefined set of access controls to this object.
    com.google.protobuf.ByteString
    getPredefinedAclBytes()
    Apply a predefined set of access controls to this object.
    Object
    getResource()
    Required.
    ObjectOrBuilder
    getResourceOrBuilder()
    Required.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasIfGenerationMatch()
    Makes the operation conditional on whether the object's current generation matches the given value.
    boolean
    hasIfGenerationNotMatch()
    Makes the operation conditional on whether the object's live generation does not match the given value.
    boolean
    hasIfMetagenerationMatch()
    Makes the operation conditional on whether the object's current metageneration matches the given value.
    boolean
    hasIfMetagenerationNotMatch()
    Makes the operation conditional on whether the object's current metageneration does not match the given value.
    boolean
    hasObjectSize()
    The expected final object size being uploaded.
    boolean
    hasResource()
    Required.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static WriteObjectSpec.Builder
    newBuilder()
     
    static WriteObjectSpec.Builder
    newBuilder(WriteObjectSpec prototype)
     
    WriteObjectSpec.Builder
    newBuilderForType()
     
    protected WriteObjectSpec.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static WriteObjectSpec
    parseDelimitedFrom(InputStream input)
     
    static WriteObjectSpec
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WriteObjectSpec
    parseFrom(byte[] data)
     
    static WriteObjectSpec
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WriteObjectSpec
    parseFrom(com.google.protobuf.ByteString data)
     
    static WriteObjectSpec
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WriteObjectSpec
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static WriteObjectSpec
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WriteObjectSpec
    parseFrom(InputStream input)
     
    static WriteObjectSpec
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WriteObjectSpec
    parseFrom(ByteBuffer data)
     
    static WriteObjectSpec
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<WriteObjectSpec>
    parser()
     
    WriteObjectSpec.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • RESOURCE_FIELD_NUMBER

      public static final int RESOURCE_FIELD_NUMBER
      See Also:

    • PREDEFINED_ACL_FIELD_NUMBER

      public static final int PREDEFINED_ACL_FIELD_NUMBER
      See Also:

    • IF_GENERATION_MATCH_FIELD_NUMBER

      public static final int IF_GENERATION_MATCH_FIELD_NUMBER
      See Also:

    • IF_GENERATION_NOT_MATCH_FIELD_NUMBER

      public static final int IF_GENERATION_NOT_MATCH_FIELD_NUMBER
      See Also:

    • IF_METAGENERATION_MATCH_FIELD_NUMBER

      public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
      See Also:

    • IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER

      public static final int IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER
      See Also:

    • OBJECT_SIZE_FIELD_NUMBER

      public static final int OBJECT_SIZE_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasResource

      public boolean hasResource()
       Required. Destination object, including its name and its metadata.
      .google.storage.v2.Object resource = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasResource in interface WriteObjectSpecOrBuilder
      Returns:
      Whether the resource field is set.

    • getResource

      public Object getResource()
       Required. Destination object, including its name and its metadata.
      .google.storage.v2.Object resource = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getResource in interface WriteObjectSpecOrBuilder
      Returns:
      The resource.

    • getResourceOrBuilder

      public ObjectOrBuilder getResourceOrBuilder()
       Required. Destination object, including its name and its metadata.
      .google.storage.v2.Object resource = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getResourceOrBuilder in interface WriteObjectSpecOrBuilder

    • 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;
      Specified by:
      getPredefinedAcl in interface WriteObjectSpecOrBuilder
      Returns:
      The predefinedAcl.

    • getPredefinedAclBytes

      public com.google.protobuf.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;
      Specified by:
      getPredefinedAclBytes in interface WriteObjectSpecOrBuilder
      Returns:
      The bytes for predefinedAcl.

    • 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;
      Specified by:
      hasIfGenerationMatch in interface WriteObjectSpecOrBuilder
      Returns:
      Whether the ifGenerationMatch field is set.

    • 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;
      Specified by:
      getIfGenerationMatch in interface WriteObjectSpecOrBuilder
      Returns:
      The ifGenerationMatch.

    • 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;
      Specified by:
      hasIfGenerationNotMatch in interface WriteObjectSpecOrBuilder
      Returns:
      Whether the ifGenerationNotMatch field is set.

    • 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;
      Specified by:
      getIfGenerationNotMatch in interface WriteObjectSpecOrBuilder
      Returns:
      The ifGenerationNotMatch.

    • 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;
      Specified by:
      hasIfMetagenerationMatch in interface WriteObjectSpecOrBuilder
      Returns:
      Whether the ifMetagenerationMatch field is set.

    • 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;
      Specified by:
      getIfMetagenerationMatch in interface WriteObjectSpecOrBuilder
      Returns:
      The ifMetagenerationMatch.

    • 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;
      Specified by:
      hasIfMetagenerationNotMatch in interface WriteObjectSpecOrBuilder
      Returns:
      Whether the ifMetagenerationNotMatch field is set.

    • 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;
      Specified by:
      getIfMetagenerationNotMatch in interface WriteObjectSpecOrBuilder
      Returns:
      The ifMetagenerationNotMatch.

    • 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.
      optional int64 object_size = 8;
      Specified by:
      hasObjectSize in interface WriteObjectSpecOrBuilder
      Returns:
      Whether the objectSize field is set.

    • 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.
      optional int64 object_size = 8;
      Specified by:
      getObjectSize in interface WriteObjectSpecOrBuilder
      Returns:
      The objectSize.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static WriteObjectSpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WriteObjectSpec parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WriteObjectSpec parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WriteObjectSpec parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WriteObjectSpec parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WriteObjectSpec parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WriteObjectSpec parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static WriteObjectSpec parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static WriteObjectSpec parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static WriteObjectSpec parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static WriteObjectSpec parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static WriteObjectSpec parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public WriteObjectSpec.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static WriteObjectSpec.Builder newBuilder()

    • newBuilder

      public static WriteObjectSpec.Builder newBuilder(WriteObjectSpec prototype)

    • toBuilder

      public WriteObjectSpec.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected WriteObjectSpec.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static WriteObjectSpec getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<WriteObjectSpec> parser()

    • getParserForType

      public com.google.protobuf.Parser<WriteObjectSpec> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public WriteObjectSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder