Package com.google.storage.v2

Interface WriteObjectSpecOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
WriteObjectSpec, WriteObjectSpec.Builder
public interface WriteObjectSpecOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getAppendable()
    If true, the object will be created in appendable mode.
    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.
    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.
    boolean
    hasAppendable()
    If true, the object will be created in appendable mode.
    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.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • hasResource

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

    • getResource

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

    • getResourceOrBuilder

      ObjectOrBuilder getResourceOrBuilder()
       Required. Destination object, including its name and its metadata.
      .google.storage.v2.Object resource = 1 [(.google.api.field_behavior) = REQUIRED];

    • getPredefinedAcl

      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;
      Returns:
      The predefinedAcl.

    • getPredefinedAclBytes

      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;
      Returns:
      The bytes for predefinedAcl.

    • hasIfGenerationMatch

      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;
      Returns:
      Whether the ifGenerationMatch field is set.

    • getIfGenerationMatch

      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;
      Returns:
      The ifGenerationMatch.

    • hasIfGenerationNotMatch

      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;
      Returns:
      Whether the ifGenerationNotMatch field is set.

    • getIfGenerationNotMatch

      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;
      Returns:
      The ifGenerationNotMatch.

    • hasIfMetagenerationMatch

      boolean hasIfMetagenerationMatch()
       Makes the operation conditional on whether the object's current
 metageneration matches the given value.
      optional int64 if_metageneration_match = 5;
      Returns:
      Whether the ifMetagenerationMatch field is set.

    • getIfMetagenerationMatch

      long getIfMetagenerationMatch()
       Makes the operation conditional on whether the object's current
 metageneration matches the given value.
      optional int64 if_metageneration_match = 5;
      Returns:
      The ifMetagenerationMatch.

    • hasIfMetagenerationNotMatch

      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;
      Returns:
      Whether the ifMetagenerationNotMatch field is set.

    • getIfMetagenerationNotMatch

      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;
      Returns:
      The ifMetagenerationNotMatch.

    • hasObjectSize

      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;
      Returns:
      Whether the objectSize field is set.

    • getObjectSize

      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;
      Returns:
      The objectSize.

    • hasAppendable

      boolean hasAppendable()
       If true, the object will be created in appendable mode.
 This field may only be set when using BidiWriteObject.
      optional bool appendable = 9;
      Returns:
      Whether the appendable field is set.

    • getAppendable

      boolean getAppendable()
       If true, the object will be created in appendable mode.
 This field may only be set when using BidiWriteObject.
      optional bool appendable = 9;
      Returns:
      The appendable.