REST Resource: projects

Resource: Project

Metadata and configurations for a Google Cloud project in the service.

JSON representation 
{
  "name": string,
  "createTime": string,
  "provisionCompletionTime": string,
  "serviceTermsMap": {
    string: {
      object (ServiceTerms)
    },
    ...
  },
  "customerProvidedConfig": {
    object (CustomerProvidedConfig)
  },
  "configurableBillingStatus": {
    object (ConfigurableBillingStatus)
  }
}
Fields
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.
createTime

string (Timestamp format)

Output only. The timestamp when this project is created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
provisionCompletionTime

string (Timestamp format)

Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
serviceTermsMap

map (key: string, value: object (ServiceTerms))

Output only. A map of terms of services. The key is the id of ServiceTerms.
customerProvidedConfig

object (CustomerProvidedConfig)

Optional. Customer provided configurations.
configurableBillingStatus

object (ConfigurableBillingStatus)

Output only. The current status of the project's configurable billing.

ServiceTerms

Metadata about the terms of service.

JSON representation 
{
  "id": string,
  "version": string,
  "state": enum (State),
  "acceptTime": string,
  "declineTime": string
}
Fields
id

string

The unique identifier of this terms of service. Available terms:
version

string

The version string of the terms of service. For acceptable values, see the comments for id above.
state

enum (State)

Whether the project has accepted/rejected the service terms or it is still pending.
acceptTime

string (Timestamp format)

The last time when the project agreed to the terms of service.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
declineTime

string (Timestamp format)

The last time when the project declined or revoked the agreement to terms of service.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

State

The agreement states this terms of service.

Enums
STATE_UNSPECIFIED The default value of the enum. This value is not actually used.
TERMS_ACCEPTED The project has given consent to the terms of service.
TERMS_PENDING The project is pending to review and accept the terms of service.
TERMS_DECLINED The project has declined or revoked the agreement to terms of service.

CustomerProvidedConfig

Customer provided configurations.

JSON representation 
{
  "notebooklmConfig": {
    object (NotebooklmConfig)
  }
}
Fields
notebooklmConfig

object (NotebooklmConfig)

Optional. Configuration for NotebookLM settings.

NotebooklmConfig

Configuration for NotebookLM.

JSON representation 
{
  "modelArmorConfig": {
    object (ModelArmorConfig)
  },
  "optOutNotebookSharing": boolean,
  "dataProtectionPolicy": {
    object (DataProtectionPolicy)
  },
  "observabilityConfig": {
    object (ObservabilityConfig)
  }
}
Fields
modelArmorConfig

object (ModelArmorConfig)

Model Armor configuration to be used for sanitizing user prompts and LLM responses.
optOutNotebookSharing

boolean

Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
dataProtectionPolicy

object (DataProtectionPolicy)

Optional. Specifies the data protection policy for NotebookLM.
observabilityConfig

object (ObservabilityConfig)

Optional. Observability config for NotebookLM.

ModelArmorConfig

Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.

JSON representation 
{
  "userPromptTemplate": string,
  "responseTemplate": string
}
Fields
userPromptTemplate

string

Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{templateId} If not specified, no sanitization will be applied to the user prompt.
responseTemplate

string

Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{templateId} If not specified, no sanitization will be applied to the LLM response.

DataProtectionPolicy

data protection policy config for NotebookLM.

JSON representation 
{
  "sensitiveDataProtectionPolicy": {
    object (SensitiveDataProtectionPolicy)
  }
}
Fields
sensitiveDataProtectionPolicy

object (SensitiveDataProtectionPolicy)

Optional. The sensitive data protection policy.

SensitiveDataProtectionPolicy

Specifies a Sensitive data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.

JSON representation 
{
  "policy": string
}
Fields
policy

string

Optional. The Sensitive data Protection policy resource name.

ConfigurableBillingStatus

Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the projects.get call. This includes the startTime of the subscription and may differ from the values in customerProvidedConfig 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 projects.patch operation.

JSON representation 
{
  "effectiveSearchQpmThreshold": string,
  "effectiveIndexingCoreThreshold": string,
  "startTime": string,
  "terminateTime": string,
  "searchQpmThresholdNextUpdateTime": string,
  "indexingCoreThresholdNextUpdateTime": string,
  "updateType": enum (UpdateType),
  "agentSearchTokenSubscriptionStatuses": [
    {
      object (AgentSearchTokenSubscriptionStatus)
    }
  ]
}
Fields
effectiveSearchQpmThreshold

string (int64 format)

Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
effectiveIndexingCoreThreshold

string (int64 format)

Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
startTime

string (Timestamp format)

Optional. The start time of the currently active billing subscription.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
terminateTime

string (Timestamp format)

Output only. The latest terminate effective time of search qpm and indexing core subscriptions.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
searchQpmThresholdNextUpdateTime

string (Timestamp format)

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.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
indexingCoreThresholdNextUpdateTime

string (Timestamp format)

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.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateType

enum (UpdateType)

Output only. The type of update performed in this operation. This field is populated in the response of projects.patch.
agentSearchTokenSubscriptionStatuses[]

object (AgentSearchTokenSubscriptionStatus)

Output only. Per-model Agent Search TPM subscription status.

UpdateType

The type of update performed on the configurable billing configuration.

Enums
UPDATE_TYPE_UNSPECIFIED Unspecified update type.
CREATE Configurable billing was created/enabled.
DELETE Configurable billing was deleted/disabled.
SCALE_UP Subscription was scaled up (thresholds increased).
SCALE_DOWN Subscription was scaled down (thresholds decreased).

AgentSearchTokenSubscriptionStatus

Per-model Agent Search TPM subscription status. One entry per active coreSubscription.agent_search_token_subscriptions[*] entry in the customer-provided config; populated by projects.patch and projects.get.

The lifecycle scalars on this message (startTime, terminateTime, updateType, tpmThresholdNextUpdateTime) are per (project, modelVersion) — siblings of the whole-relationship startTime / terminateTime / updateType 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, modelVersion), 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.

JSON representation 
{
  "modelVersion": string,
  "effectiveTpmThreshold": string,
  "tpmThresholdNextUpdateTime": string,
  "startTime": string,
  "terminateTime": string,
  "updateType": enum (UpdateType)
}
Fields
modelVersion

string

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).
effectiveTpmThreshold

string (int64 format)

Output only. The currently effective TPM threshold. Reflects scale-up immediately and scale-down at the next billing cycle, matching effectiveSearchQpmThreshold semantics.
tpmThresholdNextUpdateTime

string (Timestamp format)

Output only. The earliest next update time for the TPM subscription threshold for this (project, modelVersion). Populated only after a successful update.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
startTime

string (Timestamp format)

Output only. When this (project, modelVersion) 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 startTime on the enclosing ConfigurableBillingStatus, which continues to represent the first activation of the overall customer-configurable-pricing relationship.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
terminateTime

string (Timestamp format)

Output only. If set, the scheduled effective time at which this (project, modelVersion) Agent Search TPM subscription will terminate. Populated when the customer removes this entry from coreSubscription.agent_search_token_subscriptions[*]. Does NOT move the whole-relationship terminateTime on the enclosing ConfigurableBillingStatus, which is populated only when the entire customer-configurable-pricing relationship is being torn down.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateType

enum (UpdateType)

Output only. The type of the most recent update to this (project, modelVersion) subscription, as performed by the most recent projects.patch call. UPDATE_TYPE_UNSPECIFIED indicates this modelVersion was not touched by the most recent projects.patch (its effectiveTpmThreshold reflects an earlier update). The whole-relationship updateType 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).

Methods

get

 Gets a Project.

patch

 Updates the editable settings of a Discovery Engine Project.

provision

 Provisions the project resource.

reportConsentChange

 Updates service terms for this project.