Google Cloud Storage Control V2 Client - Class UpdateRapidCacheMetadata (1.12.3)

Reference documentation and code samples for the Google Cloud Storage Control V2 Client class UpdateRapidCacheMetadata.

Message returned in the metadata field of the Operation resource for UpdateRapidCache operation.

Generated from protobuf message google.storage.control.v2.UpdateRapidCacheMetadata

Namespace

Google \ Cloud \ Storage \ Control \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ common_metadata`	`CommonLongRunningOperationMetadata` Generic metadata for the long running operation.
`↳ rapid_cache_id`	`string` Rapid Cache ID.
`↳ zone`	`string` The zone in which the cache instance is running. For example, us-central1-a.
`↳ ttl`	`Google\Protobuf\Duration` Rapid Cache entry's TTL between 1h and 7days. A cache-level config that is applied to all new cache entries on admission. If `ttl` is pending update, this field equals to the new value specified in the Update request.
`↳ admission_policy`	`string` Optional. Rapid Cache entry Admission Policy in kebab-case (e.g., "admit-on-first-miss"). If `admission_policy` is pending update, this field equals to the new value specified in the Update request.
`↳ ingest_on_write`	`bool` Specifies whether objects are ingested into the cache upon write. If not set, it defaults to false.
`↳ cache_type`	`string` Optional. The type of cache. Either rapid cache or rapid cache ultra.

getCommonMetadata

Generic metadata for the long running operation.

Returns
Type	Description
`CommonLongRunningOperationMetadata\|null`

hasCommonMetadata

clearCommonMetadata

setCommonMetadata

Generic metadata for the long running operation.

Parameter
Name	Description
`var`	`CommonLongRunningOperationMetadata`

Returns
Type	Description
`$this`

getRapidCacheId

Rapid Cache ID.

Returns
Type	Description
`string`

hasRapidCacheId

clearRapidCacheId

setRapidCacheId

Rapid Cache ID.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getZone

The zone in which the cache instance is running. For example, us-central1-a.

Returns
Type	Description
`string`

hasZone

clearZone

setZone

The zone in which the cache instance is running. For example, us-central1-a.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTtl

Rapid Cache entry's TTL between 1h and 7days. A cache-level config that is applied to all new cache entries on admission. If ttl is pending update, this field equals to the new value specified in the Update request.

Returns
Type	Description
`Google\Protobuf\Duration\|null`

hasTtl

clearTtl

setTtl

Parameter
Name	Description
`var`	`Google\Protobuf\Duration`

Returns
Type	Description
`$this`

getAdmissionPolicy

Optional. Rapid Cache entry Admission Policy in kebab-case (e.g., "admit-on-first-miss"). If admission_policy is pending update, this field equals to the new value specified in the Update request.

Returns
Type	Description
`string`

hasAdmissionPolicy

clearAdmissionPolicy

setAdmissionPolicy