anywhere_caches

Creates, updates, deletes, gets or lists an anywhere_caches resource.

Overview

Name	anywhere_caches
Type	Resource
Id	google.storage.anywhere_caches

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The ID of the resource, including the project number, bucket name and anywhere cache ID.
admissionPolicy	string	The cache-level entry admission policy.
anywhereCacheId	string	The ID of the Anywhere cache instance.
bucket	string	The name of the bucket containing this cache instance.
createTime	string (date-time)	The creation time of the cache instance in RFC 3339 format.
ingestOnWrite	boolean	Specifies whether objects are ingested into the cache upon write.
kind	string	The kind of item this is. For Anywhere Cache, this is always storage#anywhereCache. (default: storage#anywhereCache)
pendingUpdate	boolean	True if the cache instance has an active Update long-running operation.
selfLink	string	The link to this cache instance.
state	string	The current state of the cache instance.
ttl	string (google-duration)	The TTL of all cache entries in whole seconds. e.g., "7200s".
updateTime	string (date-time)	The modification time of the cache instance metadata in RFC 3339 format.
zone	string	The zone in which the cache instance is running. For example, us-central1-a.

list

Name	Datatype	Description
id	string	The ID of the resource, including the project number, bucket name and anywhere cache ID.
admissionPolicy	string	The cache-level entry admission policy.
anywhereCacheId	string	The ID of the Anywhere cache instance.
bucket	string	The name of the bucket containing this cache instance.
createTime	string (date-time)	The creation time of the cache instance in RFC 3339 format.
ingestOnWrite	boolean	Specifies whether objects are ingested into the cache upon write.
kind	string	The kind of item this is. For Anywhere Cache, this is always storage#anywhereCache. (default: storage#anywhereCache)
pendingUpdate	boolean	True if the cache instance has an active Update long-running operation.
selfLink	string	The link to this cache instance.
state	string	The current state of the cache instance.
ttl	string (google-duration)	The TTL of all cache entries in whole seconds. e.g., "7200s".
updateTime	string (date-time)	The modification time of the cache instance metadata in RFC 3339 format.
zone	string	The zone in which the cache instance is running. For example, us-central1-a.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	bucket, anywhereCacheId		Returns the metadata of an Anywhere Cache instance.
list	select	bucket	pageSize, pageToken	Returns a list of Anywhere Cache instances of the bucket matching the criteria.
insert	insert	bucket		Creates an Anywhere Cache instance.
update	update	bucket, anywhereCacheId		Updates the config of an Anywhere Cache instance.
disable	exec	bucket, anywhereCacheId		Disables an Anywhere Cache instance.
pause	exec	bucket, anywhereCacheId		Pauses an Anywhere Cache instance.
resume	exec	bucket, anywhereCacheId		Resumes a paused or disabled Anywhere Cache instance.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
anywhereCacheId	string
bucket	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Returns the metadata of an Anywhere Cache instance.

SELECT
id,
admissionPolicy,
anywhereCacheId,
bucket,
createTime,
ingestOnWrite,
kind,
pendingUpdate,
selfLink,
state,
ttl,
updateTime,
zone
FROM google.storage.anywhere_caches
WHERE bucket = '{{ bucket }}' -- required
AND anywhereCacheId = '{{ anywhereCacheId }}' -- required
;

list

Returns a list of Anywhere Cache instances of the bucket matching the criteria.

SELECT
id,
admissionPolicy,
anywhereCacheId,
bucket,
createTime,
ingestOnWrite,
kind,
pendingUpdate,
selfLink,
state,
ttl,
updateTime,
zone
FROM google.storage.anywhere_caches
WHERE bucket = '{{ bucket }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

insert

Creates an Anywhere Cache instance.

INSERT INTO google.storage.anywhere_caches (
data__admissionPolicy,
data__anywhereCacheId,
data__bucket,
data__createTime,
data__id,
data__ingestOnWrite,
data__kind,
data__pendingUpdate,
data__selfLink,
data__state,
data__ttl,
data__updateTime,
data__zone,
bucket
)
SELECT 
'{{ admissionPolicy }}',
'{{ anywhereCacheId }}',
'{{ bucket }}',
'{{ createTime }}',
'{{ id }}',
{{ ingestOnWrite }},
'{{ kind }}',
{{ pendingUpdate }},
'{{ selfLink }}',
'{{ state }}',
'{{ ttl }}',
'{{ updateTime }}',
'{{ zone }}',
'{{ bucket }}'
RETURNING
name,
done,
error,
kind,
metadata,
response,
selfLink
;

Manifest

# Description fields are for documentation purposes
- name: anywhere_caches
props:
  - name: bucket
    value: "{{ bucket }}"
    description: Required parameter for the anywhere_caches resource.
  - name: admissionPolicy
    value: "{{ admissionPolicy }}"
    description: |
      The cache-level entry admission policy.
  - name: anywhereCacheId
    value: "{{ anywhereCacheId }}"
    description: |
      The ID of the Anywhere cache instance.
  - name: bucket
    value: "{{ bucket }}"
    description: |
      The name of the bucket containing this cache instance.
  - name: createTime
    value: "{{ createTime }}"
    description: |
      The creation time of the cache instance in RFC 3339 format.
  - name: id
    value: "{{ id }}"
    description: |
      The ID of the resource, including the project number, bucket name and anywhere cache ID.
  - name: ingestOnWrite
    value: {{ ingestOnWrite }}
    description: |
      Specifies whether objects are ingested into the cache upon write.
  - name: kind
    value: "{{ kind }}"
    description: |
      The kind of item this is. For Anywhere Cache, this is always storage#anywhereCache.
    default: storage#anywhereCache
  - name: pendingUpdate
    value: {{ pendingUpdate }}
    description: |
      True if the cache instance has an active Update long-running operation.
  - name: selfLink
    value: "{{ selfLink }}"
    description: |
      The link to this cache instance.
  - name: state
    value: "{{ state }}"
    description: |
      The current state of the cache instance.
  - name: ttl
    value: "{{ ttl }}"
    description: |
      The TTL of all cache entries in whole seconds. e.g., "7200s".
  - name: updateTime
    value: "{{ updateTime }}"
    description: |
      The modification time of the cache instance metadata in RFC 3339 format.
  - name: zone
    value: "{{ zone }}"
    description: |
      The zone in which the cache instance is running. For example, us-central1-a.

UPDATE examples

update

Updates the config of an Anywhere Cache instance.

UPDATE google.storage.anywhere_caches
SET 
data__admissionPolicy = '{{ admissionPolicy }}',
data__anywhereCacheId = '{{ anywhereCacheId }}',
data__bucket = '{{ bucket }}',
data__createTime = '{{ createTime }}',
data__id = '{{ id }}',
data__ingestOnWrite = {{ ingestOnWrite }},
data__kind = '{{ kind }}',
data__pendingUpdate = {{ pendingUpdate }},
data__selfLink = '{{ selfLink }}',
data__state = '{{ state }}',
data__ttl = '{{ ttl }}',
data__updateTime = '{{ updateTime }}',
data__zone = '{{ zone }}'
WHERE 
bucket = '{{ bucket }}' --required
AND anywhereCacheId = '{{ anywhereCacheId }}' --required
RETURNING
name,
done,
error,
kind,
metadata,
response,
selfLink;

Lifecycle Methods

disable

Disables an Anywhere Cache instance.

EXEC google.storage.anywhere_caches.disable 
@bucket='{{ bucket }}' --required, 
@anywhereCacheId='{{ anywhereCacheId }}' --required
;

pause

Pauses an Anywhere Cache instance.

EXEC google.storage.anywhere_caches.pause 
@bucket='{{ bucket }}' --required, 
@anywhereCacheId='{{ anywhereCacheId }}' --required
;

resume

Resumes a paused or disabled Anywhere Cache instance.

EXEC google.storage.anywhere_caches.resume 
@bucket='{{ bucket }}' --required, 
@anywhereCacheId='{{ anywhereCacheId }}' --required
;