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

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

A Rapid Cache Instance.

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

Namespace

Google \ Cloud \ Storage \ Control \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Immutable. The resource name of this RapidCache. Format: projects/{project}/buckets/{bucket}/rapidCaches/{rapid_cache}
↳ zone string

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

Immutable. The type of Rapid Cache this represents. Valid values include: 'rapid-cache' and 'rapid-cache-ultra'.
↳ ttl Google\Protobuf\Duration

Cache entry TTL (ranges between 1h to 7d). This is a cache-level config that defines how long a cache entry can live. Default ttl value (24hrs) is applied if not specified in the create request. TTL must be in whole seconds.
↳ admission_policy string

Cache admission policy. Valid policies includes: no_read_admission, admit-on-first-miss and admit-on-second-miss. Defaults to admit-on-first-miss for both AC and RCU. Default value is applied if not specified in the create request.
↳ state string

Output only. Cache state including running, creating, and disabled.
↳ create_time Google\Protobuf\Timestamp

Output only. Time when Rapid cache instance is allocated.
↳ update_time Google\Protobuf\Timestamp

Output only. Time when Rapid cache instance is last updated, including creation.
↳ pending_update bool

Output only. True if there is an active update operation against this cache instance. Subsequential update requests will be rejected if this field is true. Output only.

getName

Immutable. The resource name of this RapidCache.

Format: projects/{project}/buckets/{bucket}/rapidCaches/{rapid_cache}

Returns
Type Description
string

setName

Immutable. The resource name of this RapidCache.

Format: projects/{project}/buckets/{bucket}/rapidCaches/{rapid_cache}

Parameter
Name Description
var string
Returns
Type Description
$this

getZone

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

Returns
Type Description
string

setZone

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

Parameter
Name Description
var string
Returns
Type Description
$this

getCacheType

Immutable. The type of Rapid Cache this represents. Valid values include: 'rapid-cache' and 'rapid-cache-ultra'.

Returns
Type Description
string

setCacheType

Immutable. The type of Rapid Cache this represents. Valid values include: 'rapid-cache' and 'rapid-cache-ultra'.

Parameter
Name Description
var string
Returns
Type Description
$this

getTtl

Cache entry TTL (ranges between 1h to 7d). This is a cache-level config that defines how long a cache entry can live. Default ttl value (24hrs) is applied if not specified in the create request. TTL must be in whole seconds.

Returns
Type Description
Google\Protobuf\Duration|null

hasTtl

clearTtl

setTtl

Cache entry TTL (ranges between 1h to 7d). This is a cache-level config that defines how long a cache entry can live. Default ttl value (24hrs) is applied if not specified in the create request. TTL must be in whole seconds.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getAdmissionPolicy

Cache admission policy. Valid policies includes: no_read_admission, admit-on-first-miss and admit-on-second-miss. Defaults to admit-on-first-miss for both AC and RCU. Default value is applied if not specified in the create request.

Returns
Type Description
string

setAdmissionPolicy

Cache admission policy. Valid policies includes: no_read_admission, admit-on-first-miss and admit-on-second-miss. Defaults to admit-on-first-miss for both AC and RCU. Default value is applied if not specified in the create request.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. Cache state including running, creating, and disabled.

Returns
Type Description
string

setState

Output only. Cache state including running, creating, and disabled.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. Time when Rapid cache instance is allocated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time when Rapid cache instance is allocated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. Time when Rapid cache instance is last updated, including creation.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Time when Rapid cache instance is last updated, including creation.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getPendingUpdate

Output only. True if there is an active update operation against this cache instance. Subsequential update requests will be rejected if this field is true. Output only.

Returns
Type Description
bool

setPendingUpdate

Output only. True if there is an active update operation against this cache instance. Subsequential update requests will be rejected if this field is true. Output only.

Parameter
Name Description
var bool
Returns
Type Description
$this