rapid_caches

Creates, updates, deletes, gets or lists a rapid_caches resource.

Overview

Name	rapid_caches
Type	Resource
Id	google.storage.rapid_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 rapid cache ID.
admissionPolicy	string	The cache-level entry admission policy.
bucket	string	The name of the bucket containing this cache instance.
cacheType	string	The type of Rapid Cache this represents. Valid values include: "rapid-cache" and "rapid-cache-ultra".
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 Rapid Cache, this is always storage#rapidCache. (default: storage#rapidCache)
pendingUpdate	boolean	True if the cache instance has an active Update long-running operation.
rapidCacheId	string	The ID of the Rapid cache instance.
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 rapid cache ID.
admissionPolicy	string	The cache-level entry admission policy.
bucket	string	The name of the bucket containing this cache instance.
cacheType	string	The type of Rapid Cache this represents. Valid values include: "rapid-cache" and "rapid-cache-ultra".
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 Rapid Cache, this is always storage#rapidCache. (default: storage#rapidCache)
pendingUpdate	boolean	True if the cache instance has an active Update long-running operation.
rapidCacheId	string	The ID of the Rapid cache instance.
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, rapidCacheId		Returns the metadata of a Rapid Cache instance.
list	select	bucket	pageSize, pageToken	Returns a list of Rapid Cache instances of the bucket.
insert	insert	bucket		Creates a Rapid Cache instance.
update	update	bucket, rapidCacheId		Updates the configuration of a Rapid Cache instance.
disable	exec	bucket, rapidCacheId		Disables a Rapid 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
bucket	string
rapidCacheId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Returns the metadata of a Rapid Cache instance.

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

list

Returns a list of Rapid Cache instances of the bucket.

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

INSERT examples

insert

Creates a Rapid Cache instance.

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

Manifest

# Description fields are for documentation purposes
- name: rapid_caches
props:
  - name: bucket
    value: "{{ bucket }}"
    description: Required parameter for the rapid_caches resource.
  - name: admissionPolicy
    value: "{{ admissionPolicy }}"
    description: |
      The cache-level entry admission policy.
  - name: bucket
    value: "{{ bucket }}"
    description: |
      The name of the bucket containing this cache instance.
  - name: cacheType
    value: "{{ cacheType }}"
    description: |
      The type of Rapid Cache this represents. Valid values include: "rapid-cache" and "rapid-cache-ultra".
  - 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 rapid 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 Rapid Cache, this is always storage#rapidCache.
    default: storage#rapidCache
  - name: pendingUpdate
    value: {{ pendingUpdate }}
    description: |
      True if the cache instance has an active Update long-running operation.
  - name: rapidCacheId
    value: "{{ rapidCacheId }}"
    description: |
      The ID of the Rapid cache instance.
  - 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 configuration of a Rapid Cache instance.

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

Lifecycle Methods

disable

Disables a Rapid Cache instance.

EXEC google.storage.rapid_caches.disable 
@bucket='{{ bucket }}' --required, 
@rapidCacheId='{{ rapidCacheId }}' --required
;