Class GcsFilesetSpec 

public final class GcsFilesetSpec extends GeneratedMessageV3 implements GcsFilesetSpecOrBuilder
 
Describes a Cloud Storage fileset entry.

Protobuf type google.cloud.datacatalog.v1.GcsFilesetSpec

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > GcsFilesetSpec

Fields

FILE_PATTERNS_FIELD_NUMBER

public static final int FILE_PATTERNS_FIELD_NUMBER
Field Value
Type Description
int

SAMPLE_GCS_FILE_SPECS_FIELD_NUMBER

public static final int SAMPLE_GCS_FILE_SPECS_FIELD_NUMBER
Field Value
Type Description
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstance()

public static GcsFilesetSpec getDefaultInstance()
Returns
Type Description
GcsFilesetSpec

getDefaultInstanceForType()

public GcsFilesetSpec getDefaultInstanceForType()
Returns
Type Description
GcsFilesetSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

getFilePatterns(int index)

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

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The filePatterns at the given index.

getFilePatternsBytes(int index)

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

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the filePatterns at the given index.

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

Returns
Type Description
int

The count of filePatterns.

getFilePatternsList()

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

Returns
Type Description
ProtocolStringList

A list containing the filePatterns.

getParserForType()

public Parser<GcsFilesetSpec> getParserForType()
Returns
Type Description
Parser<GcsFilesetSpec>
Overrides

getSampleGcsFileSpecs(int index)

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

Parameter
Name Description
index int
Returns
Type Description
GcsFileSpec

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

Returns
Type Description
int

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

Returns
Type Description
List<GcsFileSpec>

getSampleGcsFileSpecsOrBuilder(int index)

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

Parameter
Name Description
index int
Returns
Type Description
GcsFileSpecOrBuilder

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

Returns
Type Description
List<? extends com.google.cloud.datacatalog.v1.GcsFileSpecOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilder()

public static GcsFilesetSpec.Builder newBuilder()
Returns
Type Description
GcsFilesetSpec.Builder

newBuilder(GcsFilesetSpec prototype)

public static GcsFilesetSpec.Builder newBuilder(GcsFilesetSpec prototype)
Parameter
Name Description
prototype GcsFilesetSpec
Returns
Type Description
GcsFilesetSpec.Builder

newBuilderForType()

public GcsFilesetSpec.Builder newBuilderForType()
Returns
Type Description
GcsFilesetSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GcsFilesetSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GcsFilesetSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

parseDelimitedFrom(InputStream input)

public static GcsFilesetSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GcsFilesetSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GcsFilesetSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GcsFilesetSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static GcsFilesetSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GcsFilesetSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GcsFilesetSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GcsFilesetSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GcsFilesetSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GcsFilesetSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GcsFilesetSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GcsFilesetSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GcsFilesetSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GcsFilesetSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GcsFilesetSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GcsFilesetSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static GcsFilesetSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GcsFilesetSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GcsFilesetSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GcsFilesetSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static GcsFilesetSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GcsFilesetSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GcsFilesetSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GcsFilesetSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<GcsFilesetSpec> parser()
Returns
Type Description
Parser<GcsFilesetSpec>

toBuilder()

public GcsFilesetSpec.Builder toBuilder()
Returns
Type Description
GcsFilesetSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException