Class GcsSource.Builder

  • All Implemented Interfaces:
    GcsSourceOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    GcsSource

    public static final class GcsSource.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>
    implements GcsSourceOrBuilder
     Cloud Storage location for input content.
     
    Protobuf type google.cloud.discoveryengine.v1beta.GcsSource
    • Method Detail

      • 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.Builder<GcsSource.Builder>
      • clear

        public GcsSource.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.GeneratedMessageV3.Builder<GcsSource.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.GeneratedMessageV3.Builder<GcsSource.Builder>
      • getDefaultInstanceForType

        public GcsSource getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

        public GcsSource build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public GcsSource buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • clone

        public GcsSource.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>
      • setField

        public GcsSource.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>
      • clearField

        public GcsSource.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>
      • clearOneof

        public GcsSource.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>
      • setRepeatedField

        public GcsSource.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  int index,
                                                  Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>
      • addRepeatedField

        public GcsSource.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>
      • mergeFrom

        public GcsSource.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<GcsSource.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>
      • mergeFrom

        public GcsSource.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<GcsSource.Builder>
        Throws:
        IOException
      • 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.
      • setInputUris

        public GcsSource.Builder setInputUris​(int index,
                                              String value)
         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];
        Parameters:
        index - The index to set the value at.
        value - The inputUris to set.
        Returns:
        This builder for chaining.
      • addInputUris

        public GcsSource.Builder addInputUris​(String value)
         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];
        Parameters:
        value - The inputUris to add.
        Returns:
        This builder for chaining.
      • addAllInputUris

        public GcsSource.Builder addAllInputUris​(Iterable<String> values)
         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];
        Parameters:
        values - The inputUris to add.
        Returns:
        This builder for chaining.
      • clearInputUris

        public GcsSource.Builder clearInputUris()
         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:
        This builder for chaining.
      • addInputUrisBytes

        public GcsSource.Builder addInputUrisBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes of the inputUris to add.
        Returns:
        This builder for chaining.
      • 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.v1beta.Document] per line. Each
         document must
           have a valid
           [Document.id][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.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.v1beta.Document] per line. Each
         document must
           have a valid
           [Document.id][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.UserEvent] per line.
         
        string data_schema = 2;
        Specified by:
        getDataSchemaBytes in interface GcsSourceOrBuilder
        Returns:
        The bytes for dataSchema.
      • setDataSchema

        public GcsSource.Builder setDataSchema​(String value)
         The schema to use when parsing the data from the source.
        
         Supported values for document imports:
        
         * `document` (default): One JSON
         [Document][google.cloud.discoveryengine.v1beta.Document] per line. Each
         document must
           have a valid
           [Document.id][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.UserEvent] per line.
         
        string data_schema = 2;
        Parameters:
        value - The dataSchema to set.
        Returns:
        This builder for chaining.
      • clearDataSchema

        public GcsSource.Builder clearDataSchema()
         The schema to use when parsing the data from the source.
        
         Supported values for document imports:
        
         * `document` (default): One JSON
         [Document][google.cloud.discoveryengine.v1beta.Document] per line. Each
         document must
           have a valid
           [Document.id][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.UserEvent] per line.
         
        string data_schema = 2;
        Returns:
        This builder for chaining.
      • setDataSchemaBytes

        public GcsSource.Builder setDataSchemaBytes​(com.google.protobuf.ByteString value)
         The schema to use when parsing the data from the source.
        
         Supported values for document imports:
        
         * `document` (default): One JSON
         [Document][google.cloud.discoveryengine.v1beta.Document] per line. Each
         document must
           have a valid
           [Document.id][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.UserEvent] per line.
         
        string data_schema = 2;
        Parameters:
        value - The bytes for dataSchema to set.
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final GcsSource.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>
      • mergeUnknownFields

        public final GcsSource.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GcsSource.Builder>