Google Cloud Gemini Data Analytics V1beta Client - Class Schema (0.3.0)

Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1beta Client class Schema.

The schema of a Datasource or QueryResult instance.

Generated from protobuf message google.cloud.geminidataanalytics.v1beta.Schema

Namespace

Google \ Cloud \ GeminiDataAnalytics \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ fields array<Field>

Optional. The fields in the schema.

↳ description string

Optional. A textual description of the table's content and purpose. For example: "Contains information about customer orders in our e-commerce store."

↳ synonyms array

Optional. A list of alternative names or synonyms that can be used to refer to the table. For example: ["sales", "orders", "purchases"]

↳ tags array

Optional. A list of tags or keywords associated with the table, used for categorization. For example: ["transaction", "revenue", "customer_data"]

↳ display_name string

Optional. Table display_name (same as label in cloud/data_analytics/anarres/data/looker/proto/model_explore.proto), not required, currently only Looker has this field.

↳ filters array<DataFilter>

Optional. The filters on the datasource's underlying data. Currently only used for Looker data sources.

getFields

Optional. The fields in the schema.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setFields

Optional. The fields in the schema.

Parameter
Name Description
var array<Field>
Returns
Type Description
$this

getDescription

Optional. A textual description of the table's content and purpose.

For example: "Contains information about customer orders in our e-commerce store."

Returns
Type Description
string

setDescription

Optional. A textual description of the table's content and purpose.

For example: "Contains information about customer orders in our e-commerce store."

Parameter
Name Description
var string
Returns
Type Description
$this

getSynonyms

Optional. A list of alternative names or synonyms that can be used to refer to the table. For example: ["sales", "orders", "purchases"]

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSynonyms

Optional. A list of alternative names or synonyms that can be used to refer to the table. For example: ["sales", "orders", "purchases"]

Parameter
Name Description
var string[]
Returns
Type Description
$this

getTags

Optional. A list of tags or keywords associated with the table, used for categorization. For example: ["transaction", "revenue", "customer_data"]

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTags

Optional. A list of tags or keywords associated with the table, used for categorization. For example: ["transaction", "revenue", "customer_data"]

Parameter
Name Description
var string[]
Returns
Type Description
$this

getDisplayName

Optional. Table display_name (same as label in cloud/data_analytics/anarres/data/looker/proto/model_explore.proto), not required, currently only Looker has this field.

Returns
Type Description
string

setDisplayName

Optional. Table display_name (same as label in cloud/data_analytics/anarres/data/looker/proto/model_explore.proto), not required, currently only Looker has this field.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilters

Optional. The filters on the datasource's underlying data. Currently only used for Looker data sources.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setFilters

Optional. The filters on the datasource's underlying data. Currently only used for Looker data sources.

Parameter
Name Description
var array<DataFilter>
Returns
Type Description
$this