Package com.google.cloud.datacatalog.v1

Class GcsFilesetSpec

  • All Implemented Interfaces:
    GcsFilesetSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class GcsFilesetSpec
extends com.google.protobuf.GeneratedMessageV3
implements GcsFilesetSpecOrBuilder
     Describes a Cloud Storage fileset entry.
    Protobuf type google.cloud.datacatalog.v1.GcsFilesetSpec
    See Also:
    Serialized Form

    • Field Detail

      • FILE_PATTERNS_FIELD_NUMBER

        public static final int FILE_PATTERNS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SAMPLE_GCS_FILE_SPECS_FIELD_NUMBER

        public static final int SAMPLE_GCS_FILE_SPECS_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

      • getFilePatternsList

        public com.google.protobuf.ProtocolStringList getFilePatternsList()
         Required. Patterns to identify a set of files in Google Cloud Storage.

 For more information, see [Wildcard Names]
 (https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames).

 Note: Currently, bucket wildcards are not supported.

 Examples of valid `file_patterns`:

  * `gs://bucket_name/dir/*`: matches all files in `bucket_name/dir`
                              directory
  * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir`
                               and all subdirectories
  * `gs://bucket_name/file*`: matches files prefixed by `file` in
                              `bucket_name`
  * `gs://bucket_name/??.txt`: matches files with two characters followed by
                               `.txt` in `bucket_name`
  * `gs://bucket_name/[aeiou].txt`: matches files that contain a single
                                    vowel character followed by `.txt` in
                                    `bucket_name`
  * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ...
                                  or `m` followed by `.txt` in `bucket_name`
  * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match
                              the `a/*/b` pattern, such as `a/c/b`, `a/d/b`
  * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt`

 You can combine wildcards to match complex sets of files, for example:

 `gs://bucket_name/[a-m]??.j*g`
        repeated string file_patterns = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFilePatternsList in interface GcsFilesetSpecOrBuilder
        Returns:
        A list containing the filePatterns.

      • getFilePatternsCount

        public int getFilePatternsCount()
         Required. Patterns to identify a set of files in Google Cloud Storage.

 For more information, see [Wildcard Names]
 (https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames).

 Note: Currently, bucket wildcards are not supported.

 Examples of valid `file_patterns`:

  * `gs://bucket_name/dir/*`: matches all files in `bucket_name/dir`
                              directory
  * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir`
                               and all subdirectories
  * `gs://bucket_name/file*`: matches files prefixed by `file` in
                              `bucket_name`
  * `gs://bucket_name/??.txt`: matches files with two characters followed by
                               `.txt` in `bucket_name`
  * `gs://bucket_name/[aeiou].txt`: matches files that contain a single
                                    vowel character followed by `.txt` in
                                    `bucket_name`
  * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ...
                                  or `m` followed by `.txt` in `bucket_name`
  * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match
                              the `a/*/b` pattern, such as `a/c/b`, `a/d/b`
  * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt`

 You can combine wildcards to match complex sets of files, for example:

 `gs://bucket_name/[a-m]??.j*g`
        repeated string file_patterns = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFilePatternsCount in interface GcsFilesetSpecOrBuilder
        Returns:
        The count of filePatterns.

      • getFilePatterns

        public String getFilePatterns​(int index)
         Required. Patterns to identify a set of files in Google Cloud Storage.

 For more information, see [Wildcard Names]
 (https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames).

 Note: Currently, bucket wildcards are not supported.

 Examples of valid `file_patterns`:

  * `gs://bucket_name/dir/*`: matches all files in `bucket_name/dir`
                              directory
  * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir`
                               and all subdirectories
  * `gs://bucket_name/file*`: matches files prefixed by `file` in
                              `bucket_name`
  * `gs://bucket_name/??.txt`: matches files with two characters followed by
                               `.txt` in `bucket_name`
  * `gs://bucket_name/[aeiou].txt`: matches files that contain a single
                                    vowel character followed by `.txt` in
                                    `bucket_name`
  * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ...
                                  or `m` followed by `.txt` in `bucket_name`
  * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match
                              the `a/*/b` pattern, such as `a/c/b`, `a/d/b`
  * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt`

 You can combine wildcards to match complex sets of files, for example:

 `gs://bucket_name/[a-m]??.j*g`
        repeated string file_patterns = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFilePatterns in interface GcsFilesetSpecOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The filePatterns at the given index.

      • getFilePatternsBytes

        public com.google.protobuf.ByteString getFilePatternsBytes​(int index)
         Required. Patterns to identify a set of files in Google Cloud Storage.

 For more information, see [Wildcard Names]
 (https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames).

 Note: Currently, bucket wildcards are not supported.

 Examples of valid `file_patterns`:

  * `gs://bucket_name/dir/*`: matches all files in `bucket_name/dir`
                              directory
  * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir`
                               and all subdirectories
  * `gs://bucket_name/file*`: matches files prefixed by `file` in
                              `bucket_name`
  * `gs://bucket_name/??.txt`: matches files with two characters followed by
                               `.txt` in `bucket_name`
  * `gs://bucket_name/[aeiou].txt`: matches files that contain a single
                                    vowel character followed by `.txt` in
                                    `bucket_name`
  * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ...
                                  or `m` followed by `.txt` in `bucket_name`
  * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match
                              the `a/*/b` pattern, such as `a/c/b`, `a/d/b`
  * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt`

 You can combine wildcards to match complex sets of files, for example:

 `gs://bucket_name/[a-m]??.j*g`
        repeated string file_patterns = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFilePatternsBytes in interface GcsFilesetSpecOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the filePatterns at the given index.

      • getSampleGcsFileSpecsList

        public List<GcsFileSpec> getSampleGcsFileSpecsList()
         Output only. Sample files contained in this fileset, not all files
 contained in this fileset are represented here.
        repeated .google.cloud.datacatalog.v1.GcsFileSpec sample_gcs_file_specs = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSampleGcsFileSpecsList in interface GcsFilesetSpecOrBuilder

      • getSampleGcsFileSpecsOrBuilderList

        public List<? extends GcsFileSpecOrBuilder> getSampleGcsFileSpecsOrBuilderList()
         Output only. Sample files contained in this fileset, not all files
 contained in this fileset are represented here.
        repeated .google.cloud.datacatalog.v1.GcsFileSpec sample_gcs_file_specs = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSampleGcsFileSpecsOrBuilderList in interface GcsFilesetSpecOrBuilder

      • getSampleGcsFileSpecsCount

        public int getSampleGcsFileSpecsCount()
         Output only. Sample files contained in this fileset, not all files
 contained in this fileset are represented here.
        repeated .google.cloud.datacatalog.v1.GcsFileSpec sample_gcs_file_specs = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSampleGcsFileSpecsCount in interface GcsFilesetSpecOrBuilder

      • getSampleGcsFileSpecs

        public GcsFileSpec getSampleGcsFileSpecs​(int index)
         Output only. Sample files contained in this fileset, not all files
 contained in this fileset are represented here.
        repeated .google.cloud.datacatalog.v1.GcsFileSpec sample_gcs_file_specs = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSampleGcsFileSpecs in interface GcsFilesetSpecOrBuilder

      • getSampleGcsFileSpecsOrBuilder

        public GcsFileSpecOrBuilder getSampleGcsFileSpecsOrBuilder​(int index)
         Output only. Sample files contained in this fileset, not all files
 contained in this fileset are represented here.
        repeated .google.cloud.datacatalog.v1.GcsFileSpec sample_gcs_file_specs = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSampleGcsFileSpecsOrBuilder in interface GcsFilesetSpecOrBuilder

      • 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 GcsFilesetSpec parseFrom​(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GcsFilesetSpec parseFrom​(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GcsFilesetSpec parseFrom​(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GcsFilesetSpec parseFrom​(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GcsFilesetSpec parseFrom​(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GcsFilesetSpec parseFrom​(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GcsFilesetSpec parseFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException
        Throws:
        IOException

      • newBuilderForType

        public GcsFilesetSpec.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public GcsFilesetSpec.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected GcsFilesetSpec.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static GcsFilesetSpec getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<GcsFilesetSpec> 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 GcsFilesetSpec getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder