Class GcsFilesetSpec (1.34.0)

public final class GcsFilesetSpec extends GeneratedMessageV3 implements GcsFilesetSpecOrBuilder

Describes a Cloud Storage fileset entry.

Protobuf type google.cloud.datacatalog.v1beta1.GcsFilesetSpec

Static Fields

FILE_PATTERNS_FIELD_NUMBER

public static final int FILE_PATTERNS_FIELD_NUMBER
Field Value
TypeDescription
int

SAMPLE_GCS_FILE_SPECS_FIELD_NUMBER

public static final int SAMPLE_GCS_FILE_SPECS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static GcsFilesetSpec getDefaultInstance()
Returns
TypeDescription
GcsFilesetSpec

getDescriptor()

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

newBuilder()

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

newBuilder(GcsFilesetSpec prototype)

public static GcsFilesetSpec.Builder newBuilder(GcsFilesetSpec prototype)
Parameter
NameDescription
prototypeGcsFilesetSpec
Returns
TypeDescription
GcsFilesetSpec.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public GcsFilesetSpec getDefaultInstanceForType()
Returns
TypeDescription
GcsFilesetSpec

getFilePatterns(int index)

public String getFilePatterns(int index)

Required. Patterns to identify a set of files in Google Cloud Storage. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported.

Examples of valid file_patterns:

  • gs://bucket_name/dir/*: matches all files within bucket_name/dir directory.
  • gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning 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 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 provide more powerful matches, for example:

  • gs://bucket_name/[a-m]??.j*g

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

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported.

Examples of valid file_patterns:

  • gs://bucket_name/dir/*: matches all files within bucket_name/dir directory.
  • gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning 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 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 provide more powerful matches, for example:

  • gs://bucket_name/[a-m]??.j*g

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

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported.

Examples of valid file_patterns:

  • gs://bucket_name/dir/*: matches all files within bucket_name/dir directory.
  • gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning 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 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 provide more powerful matches, for example:

  • gs://bucket_name/[a-m]??.j*g

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

Returns
TypeDescription
int

The count of filePatterns.

getFilePatternsList()

public ProtocolStringList getFilePatternsList()

Required. Patterns to identify a set of files in Google Cloud Storage. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported.

Examples of valid file_patterns:

  • gs://bucket_name/dir/*: matches all files within bucket_name/dir directory.
  • gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning 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 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 provide more powerful matches, for example:

  • gs://bucket_name/[a-m]??.j*g

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

Returns
TypeDescription
ProtocolStringList

A list containing the filePatterns.

getParserForType()

public Parser<GcsFilesetSpec> getParserForType()
Returns
TypeDescription
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.v1beta1.GcsFileSpec sample_gcs_file_specs = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta1.GcsFileSpec sample_gcs_file_specs = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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.v1beta1.GcsFileSpec sample_gcs_file_specs = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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.v1beta1.GcsFileSpec sample_gcs_file_specs = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta1.GcsFileSpec sample_gcs_file_specs = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<? extends com.google.cloud.datacatalog.v1beta1.GcsFileSpecOrBuilder>

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 GcsFilesetSpec.Builder newBuilderForType()
Returns
TypeDescription
GcsFilesetSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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