com.google.cloud.discoveryengine.v1

Class GcsSource

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1.GcsSource

All Implemented Interfaces:

GcsSourceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class GcsSource
extends com.google.protobuf.GeneratedMessageV3
implements GcsSourceOrBuilder

 Cloud Storage location for input content.
 

Protobuf type google.cloud.discoveryengine.v1.GcsSource

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GcsSource.Builder Cloud Storage location for input content.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATA_SCHEMA_FIELD_NUMBER
static int	INPUT_URIS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDataSchema() The schema to use when parsing the data from the source.
com.google.protobuf.ByteString	getDataSchemaBytes() The schema to use when parsing the data from the source.
static GcsSource	getDefaultInstance()
GcsSource	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getInputUris(int index) Required.
com.google.protobuf.ByteString	getInputUrisBytes(int index) Required.
int	getInputUrisCount() Required.
com.google.protobuf.ProtocolStringList	getInputUrisList() Required.
com.google.protobuf.Parser<GcsSource>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static GcsSource.Builder	newBuilder()
static GcsSource.Builder	newBuilder(GcsSource prototype)
GcsSource.Builder	newBuilderForType()
protected GcsSource.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static GcsSource	parseDelimitedFrom(InputStream input)
static GcsSource	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GcsSource	parseFrom(byte[] data)
static GcsSource	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GcsSource	parseFrom(ByteBuffer data)
static GcsSource	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GcsSource	parseFrom(com.google.protobuf.ByteString data)
static GcsSource	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GcsSource	parseFrom(com.google.protobuf.CodedInputStream input)
static GcsSource	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GcsSource	parseFrom(InputStream input)
static GcsSource	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<GcsSource>	parser()
GcsSource.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

INPUT_URIS_FIELD_NUMBER

public static final int INPUT_URIS_FIELD_NUMBER

See Also:

Constant Field Values

DATA_SCHEMA_FIELD_NUMBER

public static final int DATA_SCHEMA_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getInputUrisList

public com.google.protobuf.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];

Specified by:

getInputUrisList in interface GcsSourceOrBuilder

Returns:

A list containing the inputUris.

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];

Specified by:

getInputUrisCount in interface GcsSourceOrBuilder

Returns:

The count of inputUris.

getInputUris

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];

Specified by:

getInputUris in interface GcsSourceOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The inputUris at the given index.

getInputUrisBytes

public com.google.protobuf.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];

Specified by:

getInputUrisBytes in interface GcsSourceOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the inputUris at the given index.

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][google.cloud.discoveryengine.v1.Document] per line. Each
 document must
   have a valid [Document.id][google.cloud.discoveryengine.v1.Document.id].
 * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by
   `input_uris` will become 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
   the defined [Schema][google.cloud.discoveryengine.v1.Schema] of the data
   store. This can only be used by the GENERIC Data Store vertical.

 Supported values for user even imports:

 * `user_event` (default): One JSON
 [UserEvent][google.cloud.discoveryengine.v1.UserEvent] per line.
 

string data_schema = 2;

Specified by:

getDataSchema in interface GcsSourceOrBuilder

Returns:

The dataSchema.

getDataSchemaBytes

public com.google.protobuf.ByteString getDataSchemaBytes()

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

 Supported values for document imports:

 * `document` (default): One JSON
 [Document][google.cloud.discoveryengine.v1.Document] per line. Each
 document must
   have a valid [Document.id][google.cloud.discoveryengine.v1.Document.id].
 * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by
   `input_uris` will become 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
   the defined [Schema][google.cloud.discoveryengine.v1.Schema] of the data
   store. This can only be used by the GENERIC Data Store vertical.

 Supported values for user even imports:

 * `user_event` (default): One JSON
 [UserEvent][google.cloud.discoveryengine.v1.UserEvent] per line.
 

string data_schema = 2;

Specified by:

getDataSchemaBytes in interface GcsSourceOrBuilder

Returns:

The bytes for dataSchema.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static GcsSource parseFrom(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GcsSource parseFrom(ByteBuffer data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GcsSource parseFrom(com.google.protobuf.ByteString data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GcsSource parseFrom(com.google.protobuf.ByteString data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GcsSource parseFrom(byte[] data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GcsSource parseFrom(byte[] data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GcsSource parseFrom(InputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static GcsSource parseFrom(InputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static GcsSource parseDelimitedFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static GcsSource parseDelimitedFrom(InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseFrom

public static GcsSource parseFrom(com.google.protobuf.CodedInputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static GcsSource parseFrom(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

newBuilderForType

public GcsSource.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static GcsSource.Builder newBuilder()

newBuilder

public static GcsSource.Builder newBuilder(GcsSource prototype)

toBuilder

public GcsSource.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected GcsSource.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static GcsSource getDefaultInstance()

parser

public static com.google.protobuf.Parser<GcsSource> parser()

getParserForType

public com.google.protobuf.Parser<GcsSource> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public GcsSource getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder