Package com.google.storagetransfer.v1.proto

Class TransferTypes.HttpData.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<TransferTypes.HttpData.Builder>
com.google.storagetransfer.v1.proto.TransferTypes.HttpData.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TransferTypes.HttpDataOrBuilder, Cloneable
Enclosing class:
TransferTypes.HttpData
public static final class TransferTypes.HttpData.Builder extends com.google.protobuf.GeneratedMessage.Builder<TransferTypes.HttpData.Builder> implements TransferTypes.HttpDataOrBuilder
 An HttpData resource specifies a list of objects on the web to be
 transferred over HTTP.  The information of the objects to be transferred is
 contained in a file referenced by a URL. The first line in the file must be
 `"TsvHttpData-1.0"`, which specifies the format of the file.  Subsequent
 lines specify the information of the list of objects, one object per list
 entry. Each entry has the following tab-delimited fields:

 * **HTTP URL** — The location of the object.

 * **Length** — The size of the object in bytes.

 * **MD5** — The base64-encoded MD5 hash of the object.

 For an example of a valid TSV file, see
 [Transferring data from
 URLs](https://cloud.google.com/storage-transfer/docs/create-url-list).

 When transferring data based on a URL list, keep the following in mind:

 * When an object located at `http(s)://hostname:port/<URL-path>` is
 transferred to a data sink, the name of the object at the data sink is
 `<hostname>/<URL-path>`.

 * If the specified size of an object does not match the actual size of the
 object fetched, the object is not transferred.

 * If the specified MD5 does not match the MD5 computed from the transferred
 bytes, the object transfer fails.

 * Ensure that each URL you specify is publicly accessible. For
 example, in Cloud Storage you can
 [share an object publicly]
 (/storage/docs/cloud-console#_sharingdata) and get a link to it.

 * Storage Transfer Service obeys `robots.txt` rules and requires the source
 HTTP server to support `Range` requests and to return a `Content-Length`
 header in each response.

 * [ObjectConditions][google.storagetransfer.v1.ObjectConditions] have no
 effect when filtering objects to transfer.
Protobuf type google.storagetransfer.v1.HttpData

  • Method Summary

    Modifier and Type
    Method
    Description
    TransferTypes.HttpData
    build()
     
    TransferTypes.HttpData
    buildPartial()
     
    TransferTypes.HttpData.Builder
    clear()
     
    TransferTypes.HttpData.Builder
    clearListUrl()
    Required.
    TransferTypes.HttpData
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    String
    getListUrl()
    Required.
    com.google.protobuf.ByteString
    getListUrlBytes()
    Required.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    TransferTypes.HttpData.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    TransferTypes.HttpData.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    TransferTypes.HttpData.Builder
    mergeFrom(TransferTypes.HttpData other)
     
    TransferTypes.HttpData.Builder
    setListUrl(String value)
    Required.
    TransferTypes.HttpData.Builder
    setListUrlBytes(com.google.protobuf.ByteString value)
    Required.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<TransferTypes.HttpData.Builder>

    • clear

      public TransferTypes.HttpData.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<TransferTypes.HttpData.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<TransferTypes.HttpData.Builder>

    • getDefaultInstanceForType

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

    • build

      public TransferTypes.HttpData build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public TransferTypes.HttpData buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public TransferTypes.HttpData.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TransferTypes.HttpData.Builder>

    • mergeFrom

      public TransferTypes.HttpData.Builder mergeFrom(TransferTypes.HttpData other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<TransferTypes.HttpData.Builder>

    • mergeFrom

      public TransferTypes.HttpData.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TransferTypes.HttpData.Builder>
      Throws:
      IOException

    • getListUrl

      public String getListUrl()
       Required. The URL that points to the file that stores the object list
 entries. This file must allow public access. The URL is either an
 HTTP/HTTPS address (e.g. `https://example.com/urllist.tsv`) or a Cloud
 Storage path (e.g. `gs://my-bucket/urllist.tsv`).
      string list_url = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getListUrl in interface TransferTypes.HttpDataOrBuilder
      Returns:
      The listUrl.

    • getListUrlBytes

      public com.google.protobuf.ByteString getListUrlBytes()
       Required. The URL that points to the file that stores the object list
 entries. This file must allow public access. The URL is either an
 HTTP/HTTPS address (e.g. `https://example.com/urllist.tsv`) or a Cloud
 Storage path (e.g. `gs://my-bucket/urllist.tsv`).
      string list_url = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getListUrlBytes in interface TransferTypes.HttpDataOrBuilder
      Returns:
      The bytes for listUrl.

    • setListUrl

      public TransferTypes.HttpData.Builder setListUrl(String value)
       Required. The URL that points to the file that stores the object list
 entries. This file must allow public access. The URL is either an
 HTTP/HTTPS address (e.g. `https://example.com/urllist.tsv`) or a Cloud
 Storage path (e.g. `gs://my-bucket/urllist.tsv`).
      string list_url = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The listUrl to set.
      Returns:
      This builder for chaining.

    • clearListUrl

      public TransferTypes.HttpData.Builder clearListUrl()
       Required. The URL that points to the file that stores the object list
 entries. This file must allow public access. The URL is either an
 HTTP/HTTPS address (e.g. `https://example.com/urllist.tsv`) or a Cloud
 Storage path (e.g. `gs://my-bucket/urllist.tsv`).
      string list_url = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setListUrlBytes

      public TransferTypes.HttpData.Builder setListUrlBytes(com.google.protobuf.ByteString value)
       Required. The URL that points to the file that stores the object list
 entries. This file must allow public access. The URL is either an
 HTTP/HTTPS address (e.g. `https://example.com/urllist.tsv`) or a Cloud
 Storage path (e.g. `gs://my-bucket/urllist.tsv`).
      string list_url = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for listUrl to set.
      Returns:
      This builder for chaining.