Class TransferTypes.HttpData.Builder (1.54.0) 

public static final class TransferTypes.HttpData.Builder extends GeneratedMessageV3.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.

    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 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 have no effect when filtering objects to transfer.

Protobuf type google.storagetransfer.v1.HttpData

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TransferTypes.HttpData.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TransferTypes.HttpData.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TransferTypes.HttpData.Builder
Overrides

build()

public TransferTypes.HttpData build()
Returns
Type Description
TransferTypes.HttpData

buildPartial()

public TransferTypes.HttpData buildPartial()
Returns
Type Description
TransferTypes.HttpData

clear()

public TransferTypes.HttpData.Builder clear()
Returns
Type Description
TransferTypes.HttpData.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public TransferTypes.HttpData.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TransferTypes.HttpData.Builder
Overrides

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. Currently, only URLs with HTTP and HTTPS schemes are supported.

string list_url = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TransferTypes.HttpData.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TransferTypes.HttpData.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TransferTypes.HttpData.Builder
Overrides

clone()

public TransferTypes.HttpData.Builder clone()
Returns
Type Description
TransferTypes.HttpData.Builder
Overrides

getDefaultInstanceForType()

public TransferTypes.HttpData getDefaultInstanceForType()
Returns
Type Description
TransferTypes.HttpData

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getListUrl()

public String getListUrl()

Required. The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported.

string list_url = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The listUrl.

getListUrlBytes()

public ByteString getListUrlBytes()

Required. The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported.

string list_url = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for listUrl.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TransferTypes.HttpData.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.HttpData.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TransferTypes.HttpData.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TransferTypes.HttpData.Builder
Overrides

mergeFrom(TransferTypes.HttpData other)

public TransferTypes.HttpData.Builder mergeFrom(TransferTypes.HttpData other)
Parameter
Name Description
other TransferTypes.HttpData
Returns
Type Description
TransferTypes.HttpData.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TransferTypes.HttpData.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TransferTypes.HttpData.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public TransferTypes.HttpData.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TransferTypes.HttpData.Builder
Overrides

setListUrl(String value)

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. Currently, only URLs with HTTP and HTTPS schemes are supported.

string list_url = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The listUrl to set.
Returns
Type Description
TransferTypes.HttpData.Builder

This builder for chaining.

setListUrlBytes(ByteString value)

public TransferTypes.HttpData.Builder setListUrlBytes(ByteString value)

Required. The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported.

string list_url = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for listUrl to set.
Returns
Type Description
TransferTypes.HttpData.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TransferTypes.HttpData.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TransferTypes.HttpData.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final TransferTypes.HttpData.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TransferTypes.HttpData.Builder
Overrides