Debian Codegraph @

docs/dyn/discoveryengine_v1alpha.projects.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="discoveryengine_v1alpha.html">Discovery Engine API</a> . <a href="discoveryengine_v1alpha.projects.html">projects</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="discoveryengine_v1alpha.projects.locations.html">locations()</a></code>
79 </p>
80 <p class="firstline">Returns the locations Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="discoveryengine_v1alpha.projects.operations.html">operations()</a></code>
84 </p>
85 <p class="firstline">Returns the operations Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="#close">close()</a></code></p>
89 <p class="firstline">Close httplib2 connections.</p>
90 <p class="toc_element">
91 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
92 <p class="firstline">Gets a Project. Returns NOT_FOUND when the project is not yet created.</p>
93 <p class="toc_element">
94 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
95 <p class="firstline">Updates the editable settings of a Discovery Engine Project.</p>
96 <p class="toc_element">
97 <code><a href="#provision">provision(name, body=None, x__xgafv=None)</a></code></p>
98 <p class="firstline">Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.</p>
99 <p class="toc_element">
100 <code><a href="#reportConsentChange">reportConsentChange(project, body=None, x__xgafv=None)</a></code></p>
101 <p class="firstline">Updates service terms for this project. This method can be used to retroactively accept the latest terms. Terms available for update: * [Terms for data use](https://cloud.google.com/retail/data-use-terms)</p>
102 <h3>Method Details</h3>
103 <div class="method">
104 <code class="details" id="close">close()</code>
105 <pre>Close httplib2 connections.</pre>
106 </div>
107
108 <div class="method">
109 <code class="details" id="get">get(name, x__xgafv=None)</code>
110 <pre>Gets a Project. Returns NOT_FOUND when the project is not yet created.
111
112 Args:
113 name: string, Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. (required)
114 x__xgafv: string, V1 error format.
115 Allowed values
116 1 - v1 error format
117 2 - v2 error format
118
119 Returns:
120 An object of the form:
121
122 { # Metadata and configurations for a Google Cloud project in the service.
123 &quot;configurableBillingStatus&quot;: { # Represents the currently effective configurable billing parameters. These values are derived from the customer&#x27;s subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). We also include the update type to indicate the type of update performed on the configurable billing configuration in the UpdateProject operation. # Output only. The current status of the project&#x27;s configurable billing.
124 &quot;agentSearchTokenSubscriptionStatuses&quot;: [ # Output only. Per-model Agent Search TPM subscription status.
125 { # Per-model Agent Search TPM subscription status. One entry per active `core_subscription.agent_search_token_subscriptions[*]` entry in the customer-provided config; populated by UpdateProject and GetProject. The lifecycle scalars on this message (`start_time`, `terminate_time`, `update_type`, `tpm_threshold_next_update_time`) are per (project, model_version) — siblings of the whole-relationship `start_time` / `terminate_time` / `update_type` on the enclosing ConfigurableBillingStatus, but scoped to this specific Agent Search TPM subscription instead of to the overall customer-configurable- pricing relationship. This per-instance granularity is intentional: the underlying SubV3 storage is per-(project, model_version), so each model has its own activation, termination, and deferred-update clock; surfacing that on the response gives customers the granularity they need to manage per-model commitments independently. QPM / IndexingCore differ — their storage is one row per (project, location), so their lifecycle is represented only by the whole- relationship scalars on ConfigurableBillingStatus.
126 &quot;effectiveTpmThreshold&quot;: &quot;A String&quot;, # Output only. The currently effective TPM threshold. Reflects scale-up immediately and scale-down at the next billing cycle, matching `effective_search_qpm_threshold` semantics.
127 &quot;modelVersion&quot;: &quot;A String&quot;, # Output only. The Gemini model version this status corresponds to. Matches CoreSubscription.AgentSearchTokenSubscription.model_version (a stable Gemini model version from the Gemini Enterprise Agent Platform model-versions registry; see https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/model-versions#gemini-models).
128 &quot;startTime&quot;: &quot;A String&quot;, # Output only. When this (project, model_version) Agent Search TPM subscription was first activated. Set once on first activation of this model version and never moved by subsequent threshold updates; on termination + re-activation a new value is recorded. Does NOT move the whole-relationship `start_time` on the enclosing ConfigurableBillingStatus, which continues to represent the first activation of the overall customer-configurable-pricing relationship.
129 &quot;terminateTime&quot;: &quot;A String&quot;, # Output only. If set, the scheduled effective time at which this (project, model_version) Agent Search TPM subscription will terminate. Populated when the customer removes this entry from `core_subscription.agent_search_token_subscriptions[*]`. Does NOT move the whole-relationship `terminate_time` on the enclosing ConfigurableBillingStatus, which is populated only when the entire customer-configurable-pricing relationship is being torn down.
130 &quot;tpmThresholdNextUpdateTime&quot;: &quot;A String&quot;, # Output only. The earliest next update time for the TPM subscription threshold for this (project, model_version). Populated only after a successful update.
131 &quot;updateType&quot;: &quot;A String&quot;, # Output only. The type of the most recent update to this (project, model_version) subscription, as performed by the most recent UpdateProject call. `UPDATE_TYPE_UNSPECIFIED` indicates this model_version was not touched by the most recent UpdateProject (its `effective_tpm_threshold` reflects an earlier update). The whole-relationship `update_type` on the enclosing ConfigurableBillingStatus continues to summarize the direction of the most recent update across all surfaces in the project (QPM, IndexingCore, and Agent Search TPM together).
132 },
133 ],
134 &quot;effectiveIndexingCoreThreshold&quot;: &quot;A String&quot;, # Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
135 &quot;effectiveSearchQpmThreshold&quot;: &quot;A String&quot;, # Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
136 &quot;indexingCoreThresholdNextUpdateTime&quot;: &quot;A String&quot;, # Output only. The earliest next update time for the indexing core subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update indexing core subscription threshold request is succeeded.
137 &quot;searchQpmThresholdNextUpdateTime&quot;: &quot;A String&quot;, # Output only. The earliest next update time for the search QPM subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update QPM subscription threshold request is succeeded.
138 &quot;startTime&quot;: &quot;A String&quot;, # Optional. The start time of the currently active billing subscription.
139 &quot;terminateTime&quot;: &quot;A String&quot;, # Output only. The latest terminate effective time of search qpm and indexing core subscriptions.
140 &quot;updateType&quot;: &quot;A String&quot;, # Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject.
141 },
142 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp when this project is created.
143 &quot;customerProvidedConfig&quot;: { # Customer provided configurations. # Optional. Customer provided configurations.
144 &quot;notebooklmConfig&quot;: { # Configuration for NotebookLM. # Optional. Configuration for NotebookLM settings.
145 &quot;dataProtectionPolicy&quot;: { # Data protection policy config for NotebookLM. # Optional. Specifies the data protection policy for NotebookLM.
146 &quot;sensitiveDataProtectionPolicy&quot;: { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy.
147 &quot;policy&quot;: &quot;A String&quot;, # Optional. The Sensitive Data Protection policy resource name.
148 },
149 },
150 &quot;modelArmorConfig&quot;: { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. # Model Armor configuration to be used for sanitizing user prompts and LLM responses.
151 &quot;responseTemplate&quot;: &quot;A String&quot;, # Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.
152 &quot;userPromptTemplate&quot;: &quot;A String&quot;, # Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.
153 },
154 &quot;observabilityConfig&quot;: { # Observability config for a resource. # Optional. Observability config for NotebookLM.
155 &quot;observabilityEnabled&quot;: True or False, # Optional. Enables observability. If `false`, all other flags are ignored.
156 &quot;sensitiveLoggingEnabled&quot;: True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields.
157 },
158 &quot;optOutNotebookSharing&quot;: True or False, # Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
159 },
160 },
161 &quot;name&quot;: &quot;A String&quot;, # Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
162 &quot;provisionCompletionTime&quot;: &quot;A String&quot;, # Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.
163 &quot;serviceTermsMap&quot;: { # Output only. A map of terms of services. The key is the `id` of ServiceTerms.
164 &quot;a_key&quot;: { # Metadata about the terms of service.
165 &quot;acceptTime&quot;: &quot;A String&quot;, # The last time when the project agreed to the terms of service.
166 &quot;declineTime&quot;: &quot;A String&quot;, # The last time when the project declined or revoked the agreement to terms of service.
167 &quot;id&quot;: &quot;A String&quot;, # The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.
168 &quot;state&quot;: &quot;A String&quot;, # Whether the project has accepted/rejected the service terms or it is still pending.
169 &quot;version&quot;: &quot;A String&quot;, # The version string of the terms of service. For acceptable values, see the comments for id above.
170 },
171 },
172 }</pre>
173 </div>
174
175 <div class="method">
176 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
177 <pre>Updates the editable settings of a Discovery Engine Project.
178
179 Args:
180 name: string, Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. (required)
181 body: object, The request body.
182 The object takes the form of:
183
184 { # Metadata and configurations for a Google Cloud project in the service.
185 &quot;configurableBillingStatus&quot;: { # Represents the currently effective configurable billing parameters. These values are derived from the customer&#x27;s subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). We also include the update type to indicate the type of update performed on the configurable billing configuration in the UpdateProject operation. # Output only. The current status of the project&#x27;s configurable billing.
186 &quot;agentSearchTokenSubscriptionStatuses&quot;: [ # Output only. Per-model Agent Search TPM subscription status.
187 { # Per-model Agent Search TPM subscription status. One entry per active `core_subscription.agent_search_token_subscriptions[*]` entry in the customer-provided config; populated by UpdateProject and GetProject. The lifecycle scalars on this message (`start_time`, `terminate_time`, `update_type`, `tpm_threshold_next_update_time`) are per (project, model_version) — siblings of the whole-relationship `start_time` / `terminate_time` / `update_type` on the enclosing ConfigurableBillingStatus, but scoped to this specific Agent Search TPM subscription instead of to the overall customer-configurable- pricing relationship. This per-instance granularity is intentional: the underlying SubV3 storage is per-(project, model_version), so each model has its own activation, termination, and deferred-update clock; surfacing that on the response gives customers the granularity they need to manage per-model commitments independently. QPM / IndexingCore differ — their storage is one row per (project, location), so their lifecycle is represented only by the whole- relationship scalars on ConfigurableBillingStatus.
188 &quot;effectiveTpmThreshold&quot;: &quot;A String&quot;, # Output only. The currently effective TPM threshold. Reflects scale-up immediately and scale-down at the next billing cycle, matching `effective_search_qpm_threshold` semantics.
189 &quot;modelVersion&quot;: &quot;A String&quot;, # Output only. The Gemini model version this status corresponds to. Matches CoreSubscription.AgentSearchTokenSubscription.model_version (a stable Gemini model version from the Gemini Enterprise Agent Platform model-versions registry; see https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/model-versions#gemini-models).
190 &quot;startTime&quot;: &quot;A String&quot;, # Output only. When this (project, model_version) Agent Search TPM subscription was first activated. Set once on first activation of this model version and never moved by subsequent threshold updates; on termination + re-activation a new value is recorded. Does NOT move the whole-relationship `start_time` on the enclosing ConfigurableBillingStatus, which continues to represent the first activation of the overall customer-configurable-pricing relationship.
191 &quot;terminateTime&quot;: &quot;A String&quot;, # Output only. If set, the scheduled effective time at which this (project, model_version) Agent Search TPM subscription will terminate. Populated when the customer removes this entry from `core_subscription.agent_search_token_subscriptions[*]`. Does NOT move the whole-relationship `terminate_time` on the enclosing ConfigurableBillingStatus, which is populated only when the entire customer-configurable-pricing relationship is being torn down.
192 &quot;tpmThresholdNextUpdateTime&quot;: &quot;A String&quot;, # Output only. The earliest next update time for the TPM subscription threshold for this (project, model_version). Populated only after a successful update.
193 &quot;updateType&quot;: &quot;A String&quot;, # Output only. The type of the most recent update to this (project, model_version) subscription, as performed by the most recent UpdateProject call. `UPDATE_TYPE_UNSPECIFIED` indicates this model_version was not touched by the most recent UpdateProject (its `effective_tpm_threshold` reflects an earlier update). The whole-relationship `update_type` on the enclosing ConfigurableBillingStatus continues to summarize the direction of the most recent update across all surfaces in the project (QPM, IndexingCore, and Agent Search TPM together).
194 },
195 ],
196 &quot;effectiveIndexingCoreThreshold&quot;: &quot;A String&quot;, # Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
197 &quot;effectiveSearchQpmThreshold&quot;: &quot;A String&quot;, # Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
198 &quot;indexingCoreThresholdNextUpdateTime&quot;: &quot;A String&quot;, # Output only. The earliest next update time for the indexing core subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update indexing core subscription threshold request is succeeded.
199 &quot;searchQpmThresholdNextUpdateTime&quot;: &quot;A String&quot;, # Output only. The earliest next update time for the search QPM subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update QPM subscription threshold request is succeeded.
200 &quot;startTime&quot;: &quot;A String&quot;, # Optional. The start time of the currently active billing subscription.
201 &quot;terminateTime&quot;: &quot;A String&quot;, # Output only. The latest terminate effective time of search qpm and indexing core subscriptions.
202 &quot;updateType&quot;: &quot;A String&quot;, # Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject.
203 },
204 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp when this project is created.
205 &quot;customerProvidedConfig&quot;: { # Customer provided configurations. # Optional. Customer provided configurations.
206 &quot;notebooklmConfig&quot;: { # Configuration for NotebookLM. # Optional. Configuration for NotebookLM settings.
207 &quot;dataProtectionPolicy&quot;: { # Data protection policy config for NotebookLM. # Optional. Specifies the data protection policy for NotebookLM.
208 &quot;sensitiveDataProtectionPolicy&quot;: { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy.
209 &quot;policy&quot;: &quot;A String&quot;, # Optional. The Sensitive Data Protection policy resource name.
210 },
211 },
212 &quot;modelArmorConfig&quot;: { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. # Model Armor configuration to be used for sanitizing user prompts and LLM responses.
213 &quot;responseTemplate&quot;: &quot;A String&quot;, # Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.
214 &quot;userPromptTemplate&quot;: &quot;A String&quot;, # Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.
215 },
216 &quot;observabilityConfig&quot;: { # Observability config for a resource. # Optional. Observability config for NotebookLM.
217 &quot;observabilityEnabled&quot;: True or False, # Optional. Enables observability. If `false`, all other flags are ignored.
218 &quot;sensitiveLoggingEnabled&quot;: True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields.
219 },
220 &quot;optOutNotebookSharing&quot;: True or False, # Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
221 },
222 },
223 &quot;name&quot;: &quot;A String&quot;, # Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
224 &quot;provisionCompletionTime&quot;: &quot;A String&quot;, # Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.
225 &quot;serviceTermsMap&quot;: { # Output only. A map of terms of services. The key is the `id` of ServiceTerms.
226 &quot;a_key&quot;: { # Metadata about the terms of service.
227 &quot;acceptTime&quot;: &quot;A String&quot;, # The last time when the project agreed to the terms of service.
228 &quot;declineTime&quot;: &quot;A String&quot;, # The last time when the project declined or revoked the agreement to terms of service.
229 &quot;id&quot;: &quot;A String&quot;, # The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.
230 &quot;state&quot;: &quot;A String&quot;, # Whether the project has accepted/rejected the service terms or it is still pending.
231 &quot;version&quot;: &quot;A String&quot;, # The version string of the terms of service. For acceptable values, see the comments for id above.
232 },
233 },
234 }
235
236 updateMask: string, Optional. The list of fields to update. Supported fields: * `customer_provided_config` * `customer_provided_config.notebooklm_config.observability_config`
237 x__xgafv: string, V1 error format.
238 Allowed values
239 1 - v1 error format
240 2 - v2 error format
241
242 Returns:
243 An object of the form:
244
245 { # Metadata and configurations for a Google Cloud project in the service.
246 &quot;configurableBillingStatus&quot;: { # Represents the currently effective configurable billing parameters. These values are derived from the customer&#x27;s subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). We also include the update type to indicate the type of update performed on the configurable billing configuration in the UpdateProject operation. # Output only. The current status of the project&#x27;s configurable billing.
247 &quot;agentSearchTokenSubscriptionStatuses&quot;: [ # Output only. Per-model Agent Search TPM subscription status.
248 { # Per-model Agent Search TPM subscription status. One entry per active `core_subscription.agent_search_token_subscriptions[*]` entry in the customer-provided config; populated by UpdateProject and GetProject. The lifecycle scalars on this message (`start_time`, `terminate_time`, `update_type`, `tpm_threshold_next_update_time`) are per (project, model_version) — siblings of the whole-relationship `start_time` / `terminate_time` / `update_type` on the enclosing ConfigurableBillingStatus, but scoped to this specific Agent Search TPM subscription instead of to the overall customer-configurable- pricing relationship. This per-instance granularity is intentional: the underlying SubV3 storage is per-(project, model_version), so each model has its own activation, termination, and deferred-update clock; surfacing that on the response gives customers the granularity they need to manage per-model commitments independently. QPM / IndexingCore differ — their storage is one row per (project, location), so their lifecycle is represented only by the whole- relationship scalars on ConfigurableBillingStatus.
249 &quot;effectiveTpmThreshold&quot;: &quot;A String&quot;, # Output only. The currently effective TPM threshold. Reflects scale-up immediately and scale-down at the next billing cycle, matching `effective_search_qpm_threshold` semantics.
250 &quot;modelVersion&quot;: &quot;A String&quot;, # Output only. The Gemini model version this status corresponds to. Matches CoreSubscription.AgentSearchTokenSubscription.model_version (a stable Gemini model version from the Gemini Enterprise Agent Platform model-versions registry; see https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/model-versions#gemini-models).
251 &quot;startTime&quot;: &quot;A String&quot;, # Output only. When this (project, model_version) Agent Search TPM subscription was first activated. Set once on first activation of this model version and never moved by subsequent threshold updates; on termination + re-activation a new value is recorded. Does NOT move the whole-relationship `start_time` on the enclosing ConfigurableBillingStatus, which continues to represent the first activation of the overall customer-configurable-pricing relationship.
252 &quot;terminateTime&quot;: &quot;A String&quot;, # Output only. If set, the scheduled effective time at which this (project, model_version) Agent Search TPM subscription will terminate. Populated when the customer removes this entry from `core_subscription.agent_search_token_subscriptions[*]`. Does NOT move the whole-relationship `terminate_time` on the enclosing ConfigurableBillingStatus, which is populated only when the entire customer-configurable-pricing relationship is being torn down.
253 &quot;tpmThresholdNextUpdateTime&quot;: &quot;A String&quot;, # Output only. The earliest next update time for the TPM subscription threshold for this (project, model_version). Populated only after a successful update.
254 &quot;updateType&quot;: &quot;A String&quot;, # Output only. The type of the most recent update to this (project, model_version) subscription, as performed by the most recent UpdateProject call. `UPDATE_TYPE_UNSPECIFIED` indicates this model_version was not touched by the most recent UpdateProject (its `effective_tpm_threshold` reflects an earlier update). The whole-relationship `update_type` on the enclosing ConfigurableBillingStatus continues to summarize the direction of the most recent update across all surfaces in the project (QPM, IndexingCore, and Agent Search TPM together).
255 },
256 ],
257 &quot;effectiveIndexingCoreThreshold&quot;: &quot;A String&quot;, # Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
258 &quot;effectiveSearchQpmThreshold&quot;: &quot;A String&quot;, # Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
259 &quot;indexingCoreThresholdNextUpdateTime&quot;: &quot;A String&quot;, # Output only. The earliest next update time for the indexing core subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update indexing core subscription threshold request is succeeded.
260 &quot;searchQpmThresholdNextUpdateTime&quot;: &quot;A String&quot;, # Output only. The earliest next update time for the search QPM subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update QPM subscription threshold request is succeeded.
261 &quot;startTime&quot;: &quot;A String&quot;, # Optional. The start time of the currently active billing subscription.
262 &quot;terminateTime&quot;: &quot;A String&quot;, # Output only. The latest terminate effective time of search qpm and indexing core subscriptions.
263 &quot;updateType&quot;: &quot;A String&quot;, # Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject.
264 },
265 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp when this project is created.
266 &quot;customerProvidedConfig&quot;: { # Customer provided configurations. # Optional. Customer provided configurations.
267 &quot;notebooklmConfig&quot;: { # Configuration for NotebookLM. # Optional. Configuration for NotebookLM settings.
268 &quot;dataProtectionPolicy&quot;: { # Data protection policy config for NotebookLM. # Optional. Specifies the data protection policy for NotebookLM.
269 &quot;sensitiveDataProtectionPolicy&quot;: { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy.
270 &quot;policy&quot;: &quot;A String&quot;, # Optional. The Sensitive Data Protection policy resource name.
271 },
272 },
273 &quot;modelArmorConfig&quot;: { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. # Model Armor configuration to be used for sanitizing user prompts and LLM responses.
274 &quot;responseTemplate&quot;: &quot;A String&quot;, # Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.
275 &quot;userPromptTemplate&quot;: &quot;A String&quot;, # Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.
276 },
277 &quot;observabilityConfig&quot;: { # Observability config for a resource. # Optional. Observability config for NotebookLM.
278 &quot;observabilityEnabled&quot;: True or False, # Optional. Enables observability. If `false`, all other flags are ignored.
279 &quot;sensitiveLoggingEnabled&quot;: True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields.
280 },
281 &quot;optOutNotebookSharing&quot;: True or False, # Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
282 },
283 },
284 &quot;name&quot;: &quot;A String&quot;, # Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
285 &quot;provisionCompletionTime&quot;: &quot;A String&quot;, # Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.
286 &quot;serviceTermsMap&quot;: { # Output only. A map of terms of services. The key is the `id` of ServiceTerms.
287 &quot;a_key&quot;: { # Metadata about the terms of service.
288 &quot;acceptTime&quot;: &quot;A String&quot;, # The last time when the project agreed to the terms of service.
289 &quot;declineTime&quot;: &quot;A String&quot;, # The last time when the project declined or revoked the agreement to terms of service.
290 &quot;id&quot;: &quot;A String&quot;, # The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.
291 &quot;state&quot;: &quot;A String&quot;, # Whether the project has accepted/rejected the service terms or it is still pending.
292 &quot;version&quot;: &quot;A String&quot;, # The version string of the terms of service. For acceptable values, see the comments for id above.
293 },
294 },
295 }</pre>
296 </div>
297
298 <div class="method">
299 <code class="details" id="provision">provision(name, body=None, x__xgafv=None)</code>
300 <pre>Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.
301
302 Args:
303 name: string, Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. (required)
304 body: object, The request body.
305 The object takes the form of:
306
307 { # Request for ProjectService.ProvisionProject method.
308 &quot;acceptDataUseTerms&quot;: True or False, # Required. Set to `true` to specify that caller has read and would like to give consent to the [Terms for data use](https://cloud.google.com/retail/data-use-terms).
309 &quot;dataUseTermsVersion&quot;: &quot;A String&quot;, # Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time.
310 &quot;saasParams&quot;: { # Parameters for Agentspace. # Optional. Parameters for Agentspace.
311 &quot;acceptBizQos&quot;: True or False, # Optional. Set to `true` to specify that caller has read and would like to give consent to the [Terms for Agent Space quality of service].
312 &quot;isBiz&quot;: True or False, # Optional. Indicates if the current request is for Biz edition (= true) or not (= false).
313 },
314 }
315
316 x__xgafv: string, V1 error format.
317 Allowed values
318 1 - v1 error format
319 2 - v2 error format
320
321 Returns:
322 An object of the form:
323
324 { # This resource represents a long-running operation that is the result of a network API call.
325 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
326 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
327 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
328 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
329 {
330 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
331 },
332 ],
333 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
334 },
335 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
336 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
337 },
338 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
339 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
340 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
341 },
342 }</pre>
343 </div>
344
345 <div class="method">
346 <code class="details" id="reportConsentChange">reportConsentChange(project, body=None, x__xgafv=None)</code>
347 <pre>Updates service terms for this project. This method can be used to retroactively accept the latest terms. Terms available for update: * [Terms for data use](https://cloud.google.com/retail/data-use-terms)
348
349 Args:
350 project: string, Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. (required)
351 body: object, The request body.
352 The object takes the form of:
353
354 { # Request for ReportConsentChange method.
355 &quot;consentChangeAction&quot;: &quot;A String&quot;, # Required. Whether customer decides to accept or decline service term. At this moment, only accept action is supported.
356 &quot;serviceTermId&quot;: &quot;A String&quot;, # Required. The unique identifier of the terms of service to update. Available term ids: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this service term id, the acceptable service_term_version to provide is `2022-11-23`.
357 &quot;serviceTermVersion&quot;: &quot;A String&quot;, # Required. The version string of the terms of service to update.
358 }
359
360 x__xgafv: string, V1 error format.
361 Allowed values
362 1 - v1 error format
363 2 - v2 error format
364
365 Returns:
366 An object of the form:
367
368 { # Metadata and configurations for a Google Cloud project in the service.
369 &quot;configurableBillingStatus&quot;: { # Represents the currently effective configurable billing parameters. These values are derived from the customer&#x27;s subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). We also include the update type to indicate the type of update performed on the configurable billing configuration in the UpdateProject operation. # Output only. The current status of the project&#x27;s configurable billing.
370 &quot;agentSearchTokenSubscriptionStatuses&quot;: [ # Output only. Per-model Agent Search TPM subscription status.
371 { # Per-model Agent Search TPM subscription status. One entry per active `core_subscription.agent_search_token_subscriptions[*]` entry in the customer-provided config; populated by UpdateProject and GetProject. The lifecycle scalars on this message (`start_time`, `terminate_time`, `update_type`, `tpm_threshold_next_update_time`) are per (project, model_version) — siblings of the whole-relationship `start_time` / `terminate_time` / `update_type` on the enclosing ConfigurableBillingStatus, but scoped to this specific Agent Search TPM subscription instead of to the overall customer-configurable- pricing relationship. This per-instance granularity is intentional: the underlying SubV3 storage is per-(project, model_version), so each model has its own activation, termination, and deferred-update clock; surfacing that on the response gives customers the granularity they need to manage per-model commitments independently. QPM / IndexingCore differ — their storage is one row per (project, location), so their lifecycle is represented only by the whole- relationship scalars on ConfigurableBillingStatus.
372 &quot;effectiveTpmThreshold&quot;: &quot;A String&quot;, # Output only. The currently effective TPM threshold. Reflects scale-up immediately and scale-down at the next billing cycle, matching `effective_search_qpm_threshold` semantics.
373 &quot;modelVersion&quot;: &quot;A String&quot;, # Output only. The Gemini model version this status corresponds to. Matches CoreSubscription.AgentSearchTokenSubscription.model_version (a stable Gemini model version from the Gemini Enterprise Agent Platform model-versions registry; see https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/model-versions#gemini-models).
374 &quot;startTime&quot;: &quot;A String&quot;, # Output only. When this (project, model_version) Agent Search TPM subscription was first activated. Set once on first activation of this model version and never moved by subsequent threshold updates; on termination + re-activation a new value is recorded. Does NOT move the whole-relationship `start_time` on the enclosing ConfigurableBillingStatus, which continues to represent the first activation of the overall customer-configurable-pricing relationship.
375 &quot;terminateTime&quot;: &quot;A String&quot;, # Output only. If set, the scheduled effective time at which this (project, model_version) Agent Search TPM subscription will terminate. Populated when the customer removes this entry from `core_subscription.agent_search_token_subscriptions[*]`. Does NOT move the whole-relationship `terminate_time` on the enclosing ConfigurableBillingStatus, which is populated only when the entire customer-configurable-pricing relationship is being torn down.
376 &quot;tpmThresholdNextUpdateTime&quot;: &quot;A String&quot;, # Output only. The earliest next update time for the TPM subscription threshold for this (project, model_version). Populated only after a successful update.
377 &quot;updateType&quot;: &quot;A String&quot;, # Output only. The type of the most recent update to this (project, model_version) subscription, as performed by the most recent UpdateProject call. `UPDATE_TYPE_UNSPECIFIED` indicates this model_version was not touched by the most recent UpdateProject (its `effective_tpm_threshold` reflects an earlier update). The whole-relationship `update_type` on the enclosing ConfigurableBillingStatus continues to summarize the direction of the most recent update across all surfaces in the project (QPM, IndexingCore, and Agent Search TPM together).
378 },
379 ],
380 &quot;effectiveIndexingCoreThreshold&quot;: &quot;A String&quot;, # Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
381 &quot;effectiveSearchQpmThreshold&quot;: &quot;A String&quot;, # Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
382 &quot;indexingCoreThresholdNextUpdateTime&quot;: &quot;A String&quot;, # Output only. The earliest next update time for the indexing core subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update indexing core subscription threshold request is succeeded.
383 &quot;searchQpmThresholdNextUpdateTime&quot;: &quot;A String&quot;, # Output only. The earliest next update time for the search QPM subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update QPM subscription threshold request is succeeded.
384 &quot;startTime&quot;: &quot;A String&quot;, # Optional. The start time of the currently active billing subscription.
385 &quot;terminateTime&quot;: &quot;A String&quot;, # Output only. The latest terminate effective time of search qpm and indexing core subscriptions.
386 &quot;updateType&quot;: &quot;A String&quot;, # Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject.
387 },
388 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp when this project is created.
389 &quot;customerProvidedConfig&quot;: { # Customer provided configurations. # Optional. Customer provided configurations.
390 &quot;notebooklmConfig&quot;: { # Configuration for NotebookLM. # Optional. Configuration for NotebookLM settings.
391 &quot;dataProtectionPolicy&quot;: { # Data protection policy config for NotebookLM. # Optional. Specifies the data protection policy for NotebookLM.
392 &quot;sensitiveDataProtectionPolicy&quot;: { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy.
393 &quot;policy&quot;: &quot;A String&quot;, # Optional. The Sensitive Data Protection policy resource name.
394 },
395 },
396 &quot;modelArmorConfig&quot;: { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. # Model Armor configuration to be used for sanitizing user prompts and LLM responses.
397 &quot;responseTemplate&quot;: &quot;A String&quot;, # Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.
398 &quot;userPromptTemplate&quot;: &quot;A String&quot;, # Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.
399 },
400 &quot;observabilityConfig&quot;: { # Observability config for a resource. # Optional. Observability config for NotebookLM.
401 &quot;observabilityEnabled&quot;: True or False, # Optional. Enables observability. If `false`, all other flags are ignored.
402 &quot;sensitiveLoggingEnabled&quot;: True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields.
403 },
404 &quot;optOutNotebookSharing&quot;: True or False, # Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
405 },
406 },
407 &quot;name&quot;: &quot;A String&quot;, # Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
408 &quot;provisionCompletionTime&quot;: &quot;A String&quot;, # Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.
409 &quot;serviceTermsMap&quot;: { # Output only. A map of terms of services. The key is the `id` of ServiceTerms.
410 &quot;a_key&quot;: { # Metadata about the terms of service.
411 &quot;acceptTime&quot;: &quot;A String&quot;, # The last time when the project agreed to the terms of service.
412 &quot;declineTime&quot;: &quot;A String&quot;, # The last time when the project declined or revoked the agreement to terms of service.
413 &quot;id&quot;: &quot;A String&quot;, # The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.
414 &quot;state&quot;: &quot;A String&quot;, # Whether the project has accepted/rejected the service terms or it is still pending.
415 &quot;version&quot;: &quot;A String&quot;, # The version string of the terms of service. For acceptable values, see the comments for id above.
416 },
417 },
418 }</pre>
419 </div>
420
421 </body></html>