user_workloads_config_maps

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

Overview

Name	user_workloads_config_maps
Type	Resource
Id	google.composer.user_workloads_config_maps

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the ConfigMap, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}"
data	object	Optional. The "data" field of Kubernetes ConfigMap, organized in key-value pairs. For details see: https://kubernetes.io/docs/concepts/configuration/configmap/ Example: { "example_key": "example_value", "another_key": "another_value" }

list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the ConfigMap, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}"
data	object	Optional. The "data" field of Kubernetes ConfigMap, organized in key-value pairs. For details see: https://kubernetes.io/docs/concepts/configuration/configmap/ Example: { "example_key": "example_value", "another_key": "another_value" }

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, environmentsId, userWorkloadsConfigMapsId		Gets an existing user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.
list	select	projectsId, locationsId, environmentsId	pageSize, pageToken	Lists user workloads ConfigMaps. This method is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.
create	insert	projectsId, locationsId, environmentsId		Creates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.
update	replace	projectsId, locationsId, environmentsId, userWorkloadsConfigMapsId		Updates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.
delete	delete	projectsId, locationsId, environmentsId, userWorkloadsConfigMapsId		Deletes a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.

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
environmentsId	string
locationsId	string
projectsId	string
userWorkloadsConfigMapsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets an existing user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.

SELECT
name,
data
FROM google.composer.user_workloads_config_maps
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND userWorkloadsConfigMapsId = '{{ userWorkloadsConfigMapsId }}' -- required;

list

Lists user workloads ConfigMaps. This method is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.

SELECT
name,
data
FROM google.composer.user_workloads_config_maps
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Creates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.

INSERT INTO google.composer.user_workloads_config_maps (
data__name,
data__data,
projectsId,
locationsId,
environmentsId
)
SELECT 
'{{ name }}',
'{{ data }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ environmentsId }}'
RETURNING
name,
data
;

Manifest

# Description fields are for documentation purposes
- name: user_workloads_config_maps
  props:
    - name: projectsId
      value: string
      description: Required parameter for the user_workloads_config_maps resource.
    - name: locationsId
      value: string
      description: Required parameter for the user_workloads_config_maps resource.
    - name: environmentsId
      value: string
      description: Required parameter for the user_workloads_config_maps resource.
    - name: name
      value: string
      description: >
        Identifier. The resource name of the ConfigMap, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}"
        
    - name: data
      value: object
      description: >
        Optional. The "data" field of Kubernetes ConfigMap, organized in key-value pairs. For details see: https://kubernetes.io/docs/concepts/configuration/configmap/ Example: { "example_key": "example_value", "another_key": "another_value" }
        

REPLACE examples

update

Updates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.

REPLACE google.composer.user_workloads_config_maps
SET 
data__name = '{{ name }}',
data__data = '{{ data }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND userWorkloadsConfigMapsId = '{{ userWorkloadsConfigMapsId }}' --required
RETURNING
name,
data;

DELETE examples

delete

Deletes a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.

DELETE FROM google.composer.user_workloads_config_maps
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND userWorkloadsConfigMapsId = '{{ userWorkloadsConfigMapsId }}' --required;