Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1beta Client class DataResult.
Retrieved data.
Generated from protobuf message google.cloud.geminidataanalytics.v1beta.DataResult
Namespace
Google \ Cloud \ GeminiDataAnalytics \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Optional. A snake-case name for the data result that reflects its contents. The name is used to pass the result around by reference, and serves as a signal about its meaning. * * Example: "total_sales_by_product" * * Example: "sales_for_product_12345" |
↳ schema |
Schema
Optional. The schema of the data. |
↳ data |
array<Google\Protobuf\Struct>
Optional. The content of the data. Each row is a struct that matches the schema. Simple values are represented as strings, while nested structures are represented as lists or structs. |
↳ formatted_data |
array<Google\Protobuf\Struct>
Optional. Formatted representation of the data, when applicable. Each row is a struct that directly corresponds to the row at the same index within the |
getName
Optional. A snake-case name for the data result that reflects its contents.
The name is used to pass the result around by reference, and serves as a signal about its meaning.
- Example: "total_sales_by_product"
- Example: "sales_for_product_12345"
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Optional. A snake-case name for the data result that reflects its contents.
The name is used to pass the result around by reference, and serves as a signal about its meaning.
- Example: "total_sales_by_product"
- Example: "sales_for_product_12345"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSchema
Optional. The schema of the data.
| Returns | |
|---|---|
| Type | Description |
Schema|null |
|
hasSchema
clearSchema
setSchema
Optional. The schema of the data.
| Parameter | |
|---|---|
| Name | Description |
var |
Schema
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getData
Optional. The content of the data. Each row is a struct that matches the schema. Simple values are represented as strings, while nested structures are represented as lists or structs.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<Google\Protobuf\Struct> |
|
setData
Optional. The content of the data. Each row is a struct that matches the schema. Simple values are represented as strings, while nested structures are represented as lists or structs.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Protobuf\Struct>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFormattedData
Optional. Formatted representation of the data, when applicable.
Each row is a struct that directly corresponds to the row at the same index
within the data field. Its values are string representations of the
original data, formatted according to data source specifications (e.g.,
"$1,234.56" for currency). Columns without formatting will default to
their raw value representation. If no columns have formatting rules, this
field will be empty.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<Google\Protobuf\Struct> |
|
setFormattedData
Optional. Formatted representation of the data, when applicable.
Each row is a struct that directly corresponds to the row at the same index
within the data field. Its values are string representations of the
original data, formatted according to data source specifications (e.g.,
"$1,234.56" for currency). Columns without formatting will default to
their raw value representation. If no columns have formatting rules, this
field will be empty.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Protobuf\Struct>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|