Optional. Identifier. The unique resource name of a DataAgent. 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 inhttps://google.aip.dev/122#resource-id-segmentsExample:projects/1234567890/locations/us-central1/dataAgents/my-agent. It is recommended to skip setting this field during agent creation as it will be inferred automatically and overwritten with the {parent}/dataAgents/{data_agent_id}.
↳ 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.
Optional. Labels to help users filter related agents. For example, "sales", "business", "etl", and so on. Note labels are used only for filtering and not for policies. See thelabels documentationfor more details on label usage.
Optional. Identifier. The unique resource name of a DataAgent.
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 inhttps://google.aip.dev/122#resource-id-segmentsExample:projects/1234567890/locations/us-central1/dataAgents/my-agent.
It is recommended to skip setting this field during agent creation as it
will be inferred automatically and overwritten with the
{parent}/dataAgents/{data_agent_id}.
Returns
Type
Description
string
setName
Optional. Identifier. The unique resource name of a DataAgent.
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 inhttps://google.aip.dev/122#resource-id-segmentsExample:projects/1234567890/locations/us-central1/dataAgents/my-agent.
It is recommended to skip setting this field during agent creation as it
will be inferred automatically and overwritten with the
{parent}/dataAgents/{data_agent_id}.
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.
For example, "sales", "business", "etl", and so on.
Note labels are used only for filtering and not for policies.
See thelabels
documentationfor more details on label usage.
Optional. Labels to help users filter related agents.
For example, "sales", "business", "etl", and so on.
Note labels are used only for filtering and not for policies.
See thelabels
documentationfor more details on label usage.
[[["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 Gemini Data Analytics V1beta Client - Class DataAgent (0.1.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.1.1 (latest)](/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.DataAgent)\n- [0.1.0](/php/docs/reference/cloud-geminidataanalytics/0.1.0/V1beta.DataAgent) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Cloud Gemini Data Analytics V1beta Client class DataAgent.\n\nMessage describing a DataAgent object.\n\nGenerated from protobuf message `google.cloud.geminidataanalytics.v1beta.DataAgent`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ GeminiDataAnalytics \\\\ V1beta\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDataAnalyticsAgent\n\nData analytics agent.\n\n### hasDataAnalyticsAgent\n\n### setDataAnalyticsAgent\n\nData analytics agent.\n\n### getName\n\nOptional. Identifier. The unique resource name of a Agent.\n\nFormat:\n`projects/{project}/locations/{location}/dataAgents/{data_agent_id}`\n`{data_agent}` is the resource id and should be 63 characters or less and\nmust match the format described in\n\u003chttps://google.aip.dev/122#resource-id-segments\u003e\nExample: `projects/1234567890/locations/us-central1/dataAgents/my-agent`.\n\n### setName\n\nOptional. Identifier. The unique resource name of a Agent.\n\nFormat:\n`projects/{project}/locations/{location}/dataAgents/{data_agent_id}`\n`{data_agent}` is the resource id and should be 63 characters or less and\nmust match the format described in\n\u003chttps://google.aip.dev/122#resource-id-segments\u003e\nExample: `projects/1234567890/locations/us-central1/dataAgents/my-agent`.\n\n### getDisplayName\n\nOptional. User friendly display name.\n\n- Must be between 1-256 characters.\n\n### setDisplayName\n\nOptional. User friendly display name.\n\n- Must be between 1-256 characters.\n\n### getDescription\n\nOptional. Description of the agent.\n\n- Must be between 1-1024 characters.\n\n### setDescription\n\nOptional. Description of the agent.\n\n- Must be between 1-1024 characters.\n\n### getLabels\n\nOptional. Labels to help users filter related agents.\n\nE.g. \"sales\", \"business\", \"etl\", etc.\nNote labels are only used for filtering and not for policies.\nSee \u003chttps://cloud.google.com/resource-manager/docs/labels-overview\u003e for more\ndetails on label usage.\n\n### setLabels\n\nOptional. Labels to help users filter related agents.\n\nE.g. \"sales\", \"business\", \"etl\", etc.\nNote labels are only used for filtering and not for policies.\nSee \u003chttps://cloud.google.com/resource-manager/docs/labels-overview\u003e for more\ndetails on label usage.\n\n### getCreateTime\n\nOutput only. The time when the data agent was created.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. The time when the data agent was created.\n\n### getUpdateTime\n\nOutput only. The time when the data agent was last updated.\n\n### hasUpdateTime\n\n### clearUpdateTime\n\n### setUpdateTime\n\nOutput only. The time when the data agent was last updated.\n\n### getDeleteTime\n\nOutput only. \\[Output only\\] The time the data agent was soft deleted.\n\n### hasDeleteTime\n\n### clearDeleteTime\n\n### setDeleteTime\n\nOutput only. \\[Output only\\] The time the data agent was soft deleted.\n\n### getPurgeTime\n\nOutput only. Timestamp in UTC of when this data agent is considered\nexpired. This is *always* provided on output, regardless of what was sent\non input.\n\n### hasPurgeTime\n\n### clearPurgeTime\n\n### setPurgeTime\n\nOutput only. Timestamp in UTC of when this data agent is considered\nexpired. This is *always* provided on output, regardless of what was sent\non input.\n\n### getType"]]
