Class GcsSource (0.28.0)

public final class GcsSource extends GeneratedMessageV3 implements GcsSourceOrBuilder

Cloud Storage location for input content.

Protobuf type google.cloud.discoveryengine.v1alpha.GcsSource

Implements

GcsSourceOrBuilder

Static Fields

DATA_SCHEMA_FIELD_NUMBER

public static final int DATA_SCHEMA_FIELD_NUMBER
Field Value
TypeDescription
int

INPUT_URIS_FIELD_NUMBER

public static final int INPUT_URIS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static GcsSource getDefaultInstance()
Returns
TypeDescription
GcsSource

getDescriptor()

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

newBuilder()

public static GcsSource.Builder newBuilder()
Returns
TypeDescription
GcsSource.Builder

newBuilder(GcsSource prototype)

public static GcsSource.Builder newBuilder(GcsSource prototype)
Parameter
NameDescription
prototypeGcsSource
Returns
TypeDescription
GcsSource.Builder

parseDelimitedFrom(InputStream input)

public static GcsSource parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GcsSource
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static GcsSource parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
GcsSource
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static GcsSource parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
GcsSource
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static GcsSource parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GcsSource
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static GcsSource parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
GcsSource
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<GcsSource> parser()
Returns
TypeDescription
Parser<GcsSource>

Methods

equals(Object obj)

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

getDataSchema()

public String getDataSchema()

The schema to use when parsing the data from the source.

Supported values for document imports:

  • document (default): One JSON Document per line. Each document must have a valid Document.id.
  • content: Unstructured data (e.g. PDF, HTML). Each file matched by input_uris becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string.
  • custom: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder.
  • csv: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by Gen App Builder.

    Supported values for user even imports:

  • user_event (default): One JSON UserEvent per line.

string data_schema = 2;

Returns
TypeDescription
String

The dataSchema.

getDataSchemaBytes()

public ByteString getDataSchemaBytes()

The schema to use when parsing the data from the source.

Supported values for document imports:

  • document (default): One JSON Document per line. Each document must have a valid Document.id.
  • content: Unstructured data (e.g. PDF, HTML). Each file matched by input_uris becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string.
  • custom: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder.
  • csv: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by Gen App Builder.

    Supported values for user even imports:

  • user_event (default): One JSON UserEvent per line.

string data_schema = 2;

Returns
TypeDescription
ByteString

The bytes for dataSchema.

getDefaultInstanceForType()

public GcsSource getDefaultInstanceForType()
Returns
TypeDescription
GcsSource

getInputUris(int index)

public String getInputUris(int index)

Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, gs://bucket/directory/object.json) or a pattern matching one or more files, such as gs://bucket/directory/*.json.

A request can contain at most 100 files (or 100,000 files if data_schema is content). Each file can be up to 2 GB (or 100 MB if data_schema is content).

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

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The inputUris at the given index.

getInputUrisBytes(int index)

public ByteString getInputUrisBytes(int index)

Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, gs://bucket/directory/object.json) or a pattern matching one or more files, such as gs://bucket/directory/*.json.

A request can contain at most 100 files (or 100,000 files if data_schema is content). Each file can be up to 2 GB (or 100 MB if data_schema is content).

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

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the inputUris at the given index.

getInputUrisCount()

public int getInputUrisCount()

Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, gs://bucket/directory/object.json) or a pattern matching one or more files, such as gs://bucket/directory/*.json.

A request can contain at most 100 files (or 100,000 files if data_schema is content). Each file can be up to 2 GB (or 100 MB if data_schema is content).

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

Returns
TypeDescription
int

The count of inputUris.

getInputUrisList()

public ProtocolStringList getInputUrisList()

Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, gs://bucket/directory/object.json) or a pattern matching one or more files, such as gs://bucket/directory/*.json.

A request can contain at most 100 files (or 100,000 files if data_schema is content). Each file can be up to 2 GB (or 100 MB if data_schema is content).

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

Returns
TypeDescription
ProtocolStringList

A list containing the inputUris.

getParserForType()

public Parser<GcsSource> getParserForType()
Returns
TypeDescription
Parser<GcsSource>
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 GcsSource.Builder newBuilderForType()
Returns
TypeDescription
GcsSource.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public GcsSource.Builder toBuilder()
Returns
TypeDescription
GcsSource.Builder

writeTo(CodedOutputStream output)

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