Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class GcsFilesetSpec.
Describes a Cloud Storage fileset entry.
Generated from protobuf message google.cloud.datacatalog.v1.GcsFilesetSpec
Namespace
Google \ Cloud \ DataCatalog \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ file_patterns
array
Required. Patterns to identify a set of files in Google Cloud Storage. For more information, see Wildcard Names. 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
Output only. Sample files contained in this fileset, not all files contained in this fileset are represented here.
getFilePatterns
Required. Patterns to identify a set of files in Google Cloud Storage.
For more information, see Wildcard Names.
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
Required. Patterns to identify a set of files in Google Cloud Storage.
For more information, see Wildcard Names.
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
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getSampleGcsFileSpecs
Output only. Sample files contained in this fileset, not all files
contained in this fileset are represented here.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Cloud Data Catalog V1 Client - Class GcsFilesetSpec (2.3.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.2 (latest)](/php/docs/reference/cloud-data-catalog/latest/V1.GcsFilesetSpec)\n- [2.3.1](/php/docs/reference/cloud-data-catalog/2.3.1/V1.GcsFilesetSpec)\n- [2.2.4](/php/docs/reference/cloud-data-catalog/2.2.4/V1.GcsFilesetSpec)\n- [2.1.0](/php/docs/reference/cloud-data-catalog/2.1.0/V1.GcsFilesetSpec)\n- [2.0.2](/php/docs/reference/cloud-data-catalog/2.0.2/V1.GcsFilesetSpec)\n- [1.10.3](/php/docs/reference/cloud-data-catalog/1.10.3/V1.GcsFilesetSpec)\n- [1.9.1](/php/docs/reference/cloud-data-catalog/1.9.1/V1.GcsFilesetSpec)\n- [1.8.2](/php/docs/reference/cloud-data-catalog/1.8.2/V1.GcsFilesetSpec)\n- [1.7.1](/php/docs/reference/cloud-data-catalog/1.7.1/V1.GcsFilesetSpec)\n- [1.6.0](/php/docs/reference/cloud-data-catalog/1.6.0/V1.GcsFilesetSpec)\n- [1.5.1](/php/docs/reference/cloud-data-catalog/1.5.1/V1.GcsFilesetSpec)\n- [1.4.2](/php/docs/reference/cloud-data-catalog/1.4.2/V1.GcsFilesetSpec)\n- [1.3.9](/php/docs/reference/cloud-data-catalog/1.3.9/V1.GcsFilesetSpec) \nReference documentation and code samples for the Google Cloud Data Catalog V1 Client class GcsFilesetSpec.\n\nDescribes a Cloud Storage fileset entry.\n\nGenerated from protobuf message `google.cloud.datacatalog.v1.GcsFilesetSpec`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DataCatalog \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getFilePatterns\n\nRequired. Patterns to identify a set of files in Google Cloud Storage.\n\nFor more information, see [Wildcard Names](https://cloud.google.com/storage/docs/wildcards).\nNote: Currently, bucket wildcards are not supported.\nExamples of valid `file_patterns`:\n\n- `gs://bucket_name/dir/*`: matches all files in `bucket_name/dir` directory\n- `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir` and all subdirectories\n- `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name`\n- `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name`\n- `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name`\n- `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name`\n- `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`\n- `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`\n\n### setFilePatterns\n\nRequired. Patterns to identify a set of files in Google Cloud Storage.\n\nFor more information, see [Wildcard Names](https://cloud.google.com/storage/docs/wildcards).\nNote: Currently, bucket wildcards are not supported.\nExamples of valid `file_patterns`:\n\n- `gs://bucket_name/dir/*`: matches all files in `bucket_name/dir` directory\n- `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir` and all subdirectories\n- `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name`\n- `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name`\n- `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name`\n- `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name`\n- `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`\n- `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`\n\n### getSampleGcsFileSpecs\n\nOutput only. Sample files contained in this fileset, not all files\ncontained in this fileset are represented here.\n\n### setSampleGcsFileSpecs\n\nOutput only. Sample files contained in this fileset, not all files\ncontained in this fileset are represented here."]]
