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

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

Message returned in the metadata field of the Operation resource for CreateAnywhereCache operations.

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

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.

↳ anywhere_cache_id string

Anywhere Cache ID.

↳ zone string

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

↳ ttl Google\Protobuf\Duration

Anywhere Cache entry's TTL. A cache-level config that is applied to all new cache entries on admission. Default ttl value (24hrs) is applied if not specified in the create request.

↳ admission_policy string

Anywhere Cache entry Admission Policy in kebab-case (e.g., "admit-on-first-miss"). Default admission policy (admit-on-first-miss) is applied if not specified in the create request.

↳ ingest_on_write bool

Optional. Specifies whether objects are ingested into the cache upon write. Defaults to false.

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

getAnywhereCacheId

Anywhere Cache ID.

Returns
Type Description
string

hasAnywhereCacheId

clearAnywhereCacheId

setAnywhereCacheId

Anywhere 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

Anywhere Cache entry's TTL. A cache-level config that is applied to all new cache entries on admission. Default ttl value (24hrs) is applied if not specified in the create request.

Returns
Type Description
Google\Protobuf\Duration|null

hasTtl

clearTtl

setTtl

Anywhere Cache entry's TTL. A cache-level config that is applied to all new cache entries on admission. Default ttl value (24hrs) is applied if not specified in the create request.

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

getAdmissionPolicy

Anywhere Cache entry Admission Policy in kebab-case (e.g., "admit-on-first-miss"). Default admission policy (admit-on-first-miss) is applied if not specified in the create request.

Returns
Type Description
string

hasAdmissionPolicy

clearAdmissionPolicy

setAdmissionPolicy

Anywhere Cache entry Admission Policy in kebab-case (e.g., "admit-on-first-miss"). Default admission policy (admit-on-first-miss) is applied if not specified in the create request.

Parameter
Name Description
var string
Returns
Type Description
$this

getIngestOnWrite

Optional. Specifies whether objects are ingested into the cache upon write.

Defaults to false.

Returns
Type Description
bool

hasIngestOnWrite

clearIngestOnWrite

setIngestOnWrite

Optional. Specifies whether objects are ingested into the cache upon write.

Defaults to false.

Parameter
Name Description
var bool
Returns
Type Description
$this