actuations

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

Overview

Name	actuations
Type	Resource
Id	google.workloadmanager.actuations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	The name of the actuation resource. The format is projects/{project}/locations/{location}/deployments/{deployment}/actuations/{actuation}.
actuationOutput	object	Output only. Actuation output. (id: ActuationOutput)
deploymentOutput	array	Output only. Deployment output.
endTime	string (google-datetime)	Output only. End time stamp.
startTime	string (google-datetime)	Output only. Start time stamp.
state	string	Output only. Actuation state. (STATE_UNSPECIFIED, INFRA_CREATING, SUCCEEDED, FAILED, POST_INFRA_CONFIGURING, INFRA_DESTROYING, TIMEOUT)

list

Name	Datatype	Description
name	string	The name of the actuation resource. The format is projects/{project}/locations/{location}/deployments/{deployment}/actuations/{actuation}.
actuationOutput	object	Output only. Actuation output. (id: ActuationOutput)
deploymentOutput	array	Output only. Deployment output.
endTime	string (google-datetime)	Output only. End time stamp.
startTime	string (google-datetime)	Output only. Start time stamp.
state	string	Output only. Actuation state. (STATE_UNSPECIFIED, INFRA_CREATING, SUCCEEDED, FAILED, POST_INFRA_CONFIGURING, INFRA_DESTROYING, TIMEOUT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, deploymentsId, actuationsId		Gets details of a single Actuation.
list	select	projectsId, locationsId, deploymentsId	filter, orderBy, pageSize, pageToken	Lists Actuations in a given project, location and deployment.
create	insert	projectsId, locationsId, deploymentsId	requestId	Creates a new actuation for an existing Deployment.
delete	delete	projectsId, locationsId, deploymentsId, actuationsId		Deletes a single Actuation.

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
actuationsId	string
deploymentsId	string
locationsId	string
projectsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string

SELECT examples

get

Gets details of a single Actuation.

SELECT
name,
actuationOutput,
deploymentOutput,
endTime,
startTime,
state
FROM google.workloadmanager.actuations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND deploymentsId = '{{ deploymentsId }}' -- required
AND actuationsId = '{{ actuationsId }}' -- required
;

list

Lists Actuations in a given project, location and deployment.

SELECT
name,
actuationOutput,
deploymentOutput,
endTime,
startTime,
state
FROM google.workloadmanager.actuations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND deploymentsId = '{{ deploymentsId }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates a new actuation for an existing Deployment.

INSERT INTO google.workloadmanager.actuations (
data__name,
projectsId,
locationsId,
deploymentsId,
requestId
)
SELECT 
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ deploymentsId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: actuations
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the actuations resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the actuations resource.
  - name: deploymentsId
    value: "{{ deploymentsId }}"
    description: Required parameter for the actuations resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the actuation resource. The format is projects/{project}/locations/{location}/deployments/{deployment}/actuations/{actuation}.
  - name: requestId
    value: "{{ requestId }}"

DELETE examples

delete

Deletes a single Actuation.

DELETE FROM google.workloadmanager.actuations
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND deploymentsId = '{{ deploymentsId }}' --required
AND actuationsId = '{{ actuationsId }}' --required
;