Method: nativeDashboards.manageLease

Full name: projects.locations.instances.nativeDashboards.manageLease

Manages dashboard lease for auto-refreshing charts.

HTTP request

POST https://{endpoint}/v1alpha/{parent}/nativeDashboards:manageLease

Where {endpoint} is one of the supported service endpoints.

Path parameters

Parameters
parent

string

Required. The instance resource name. Format: projects/{project}/locations/{location}/instances/{instance}

Auto-refresh capacity is a tenant-level pool, so the lease is scoped to the parent instance rather than to any single dashboard.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "leaseOperationType": enum (LeaseOperationType),
  "requestedChartCount": integer,
  "leaseToken": string
}
Fields
leaseOperationType

enum (LeaseOperationType)

Required. The lease operation to perform.
requestedChartCount

integer

Optional. How many charts the client wants to auto-refresh concurrently. Required and must be greater than zero for ACQUIRE. Optional for RENEW (defaults to previously granted count if unset or zero). Optional for CHECK_QUOTA (ignored or used as an upper bound check). Ignored for RELEASE.
leaseToken

string (bytes format)

Optional. Opaque lease token returned by a previous call. Required for RENEW and RELEASE operations. Ignored for ACQUIRE and CHECK_QUOTA.

A base64-encoded string.

Response body

Response from managing the auto-refresh lease.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "leaseToken": string,
  "renewInterval": string,
  "availableChartCount": integer,
  "maxChartCount": integer
}
Fields
leaseToken

string (bytes format)

Opaque token to echo in the next RENEW or RELEASE. Empty for RELEASE and CHECK_QUOTA responses.

A base64-encoded string.
renewInterval

string (Duration format)

How long the client should wait before sending the next RENEW. Unset for RELEASE and CHECK_QUOTA.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
availableChartCount

integer

The number of unreserved auto-refresh chart slots remaining across the tenant. Populated on CHECK_QUOTA operations or when capacity is exhausted.
maxChartCount

integer

The tenant-wide maximum concurrent auto-refresh chart cap. Populated on CHECK_QUOTA operations or when capacity is exhausted.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/chronicle

For more information, see the Authentication Overview.

LeaseOperationType

Operation type for the lease.

New values may be added to this enum in the future.

Enums
LEASE_OPERATION_TYPE_UNSPECIFIED Unspecified operation.
ACQUIRE Acquire a new lease.
RENEW Renew an existing lease. Extends the reservation into the next quota epoch. If requestedChartCount is omitted or zero, the previously granted count is retained.
RELEASE Release an existing lease.
CHECK_QUOTA Check available tenant-wide auto-refresh quota without acquiring a lease.