Google Cloud Gemini Data Analytics V1beta Client - Class DataAgent (0.1.0)

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

Message describing a DataAgent object.

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

Namespace

Google \ Cloud \ GeminiDataAnalytics \ V1beta

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ data_analytics_agent
DataAnalyticsAgent

Data analytics agent.

↳ name
string

Optional. Identifier. The unique resource name of a Agent. Format: projects/{project}/locations/{location}/dataAgents/{data_agent_id} {data_agent} is the resource id and should be 63 characters or less and must match the format described in https://google.aip.dev/122#resource-id-segments Example: projects/1234567890/locations/us-central1/dataAgents/my-agent .

↳ display_name
string

Optional. User friendly display name. * * Must be between 1-256 characters.

↳ description
string

Optional. Description of the agent. * * Must be between 1-1024 characters.

↳ labels
array| Google\Protobuf\Internal\MapField

Optional. Labels to help users filter related agents. E.g. "sales", "business", "etl", etc. Note labels are only used for filtering and not for policies. See https://cloud.google.com/resource-manager/docs/labels-overview for more details on label usage.

↳ create_time
Google\Protobuf\Timestamp

Output only. The time when the data agent was created.

↳ update_time
Google\Protobuf\Timestamp

Output only. The time when the data agent was last updated.

↳ delete_time
Google\Protobuf\Timestamp

Output only. [Output only] The time the data agent was soft deleted.

↳ purge_time
Google\Protobuf\Timestamp

Output only. Timestamp in UTC of when this data agent is considered expired. This is always provided on output, regardless of what was sent on input.

getDataAnalyticsAgent

Data analytics agent.

Returns
Type
Description

hasDataAnalyticsAgent

setDataAnalyticsAgent

Data analytics agent.

Parameter
Name
Description
Returns
Type
Description
$this

getName

Optional. Identifier. The unique resource name of a Agent.

Format: projects/{project}/locations/{location}/dataAgents/{data_agent_id} {data_agent} is the resource id and should be 63 characters or less and must match the format described in https://google.aip.dev/122#resource-id-segments Example: projects/1234567890/locations/us-central1/dataAgents/my-agent .

Returns
Type
Description
string

setName

Optional. Identifier. The unique resource name of a Agent.

Format: projects/{project}/locations/{location}/dataAgents/{data_agent_id} {data_agent} is the resource id and should be 63 characters or less and must match the format described in https://google.aip.dev/122#resource-id-segments Example: projects/1234567890/locations/us-central1/dataAgents/my-agent .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDisplayName

Optional. User friendly display name.

  • Must be between 1-256 characters.
Returns
Type
Description
string

setDisplayName

Optional. User friendly display name.

  • Must be between 1-256 characters.
Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDescription

Optional. Description of the agent.

  • Must be between 1-1024 characters.
Returns
Type
Description
string

setDescription

Optional. Description of the agent.

  • Must be between 1-1024 characters.
Parameter
Name
Description
var
string
Returns
Type
Description
$this

getLabels

Optional. Labels to help users filter related agents.

E.g. "sales", "business", "etl", etc. Note labels are only used for filtering and not for policies. See https://cloud.google.com/resource-manager/docs/labels-overview for more details on label usage.

Returns
Type
Description

setLabels

Optional. Labels to help users filter related agents.

E.g. "sales", "business", "etl", etc. Note labels are only used for filtering and not for policies. See https://cloud.google.com/resource-manager/docs/labels-overview for more details on label usage.

Parameter
Name
Description
Returns
Type
Description
$this

getCreateTime

Output only. The time when the data agent was created.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the data agent was created.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. The time when the data agent was last updated.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time when the data agent was last updated.

Parameter
Name
Description
Returns
Type
Description
$this

getDeleteTime

Output only. [Output only] The time the data agent was soft deleted.

Returns
Type
Description

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. [Output only] The time the data agent was soft deleted.

Parameter
Name
Description
Returns
Type
Description
$this

getPurgeTime

Output only. Timestamp in UTC of when this data agent is considered expired. This is always provided on output, regardless of what was sent on input.

Returns
Type
Description

hasPurgeTime

clearPurgeTime

setPurgeTime

Output only. Timestamp in UTC of when this data agent is considered expired. This is always provided on output, regardless of what was sent on input.

Parameter
Name
Description
Returns
Type
Description
$this

getType

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: