Class TransferTypes.HttpData (1.37.0)

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

Static Fields

LIST_URL_FIELD_NUMBER

public static final int LIST_URL_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TransferTypes.HttpData getDefaultInstance()
Returns
TypeDescription
TransferTypes.HttpData

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static TransferTypes.HttpData.Builder newBuilder()
Returns
TypeDescription
TransferTypes.HttpData.Builder

newBuilder(TransferTypes.HttpData prototype)

public static TransferTypes.HttpData.Builder newBuilder(TransferTypes.HttpData prototype)
Parameter
NameDescription
prototypeTransferTypes.HttpData
Returns
TypeDescription
TransferTypes.HttpData.Builder

parseDelimitedFrom(InputStream input)

public static TransferTypes.HttpData parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TransferTypes.HttpData
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.HttpData parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferTypes.HttpData
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TransferTypes.HttpData parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TransferTypes.HttpData
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.HttpData parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferTypes.HttpData
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransferTypes.HttpData parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TransferTypes.HttpData
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.HttpData parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferTypes.HttpData
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransferTypes.HttpData parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TransferTypes.HttpData
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.HttpData parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferTypes.HttpData
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TransferTypes.HttpData parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TransferTypes.HttpData
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.HttpData parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferTypes.HttpData
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TransferTypes.HttpData parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TransferTypes.HttpData
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.HttpData parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferTypes.HttpData
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<TransferTypes.HttpData> parser()
Returns
TypeDescription
Parser<HttpData>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public TransferTypes.HttpData getDefaultInstanceForType()
Returns
TypeDescription
TransferTypes.HttpData

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
TypeDescription
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
TypeDescription
ByteString

The bytes for listUrl.

getParserForType()

public Parser<TransferTypes.HttpData> getParserForType()
Returns
TypeDescription
Parser<HttpData>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public TransferTypes.HttpData.Builder newBuilderForType()
Returns
TypeDescription
TransferTypes.HttpData.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransferTypes.HttpData.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TransferTypes.HttpData.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public TransferTypes.HttpData.Builder toBuilder()
Returns
TypeDescription
TransferTypes.HttpData.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException