certificate_maps

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

Overview

Name	certificate_maps
Type	Resource
Id	google.certificatemanager.certificate_maps

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern projects/*/locations/*/certificateMaps/*.
createTime	string (google-datetime)	Output only. The creation timestamp of a Certificate Map.
description	string	Optional. One or more paragraphs of text description of a certificate map.
gclbTargets	array	Output only. A list of GCLB targets that use this Certificate Map. A Target Proxy is only present on this list if it's attached to a Forwarding Rule.
labels	object	Optional. Set of labels associated with a Certificate Map.
updateTime	string (google-datetime)	Output only. The update timestamp of a Certificate Map.

list

Successful response

Name	Datatype	Description
name	string	Identifier. A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern projects/*/locations/*/certificateMaps/*.
createTime	string (google-datetime)	Output only. The creation timestamp of a Certificate Map.
description	string	Optional. One or more paragraphs of text description of a certificate map.
gclbTargets	array	Output only. A list of GCLB targets that use this Certificate Map. A Target Proxy is only present on this list if it's attached to a Forwarding Rule.
labels	object	Optional. Set of labels associated with a Certificate Map.
updateTime	string (google-datetime)	Output only. The update timestamp of a Certificate Map.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, certificateMapsId		Gets details of a single CertificateMap.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists CertificateMaps in a given project and location.
create	insert	projectsId, locationsId	certificateMapId	Creates a new CertificateMap in a given project and location.
patch	update	projectsId, locationsId, certificateMapsId	updateMask	Updates a CertificateMap.
delete	delete	projectsId, locationsId, certificateMapsId		Deletes a single CertificateMap. A Certificate Map can't be deleted if it contains Certificate Map Entries. Remove all the entries from the map before calling this method.

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
certificateMapsId	string
locationsId	string
projectsId	string
certificateMapId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single CertificateMap.

SELECT
name,
createTime,
description,
gclbTargets,
labels,
updateTime
FROM google.certificatemanager.certificate_maps
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND certificateMapsId = '{{ certificateMapsId }}' -- required;

list

Lists CertificateMaps in a given project and location.

SELECT
name,
createTime,
description,
gclbTargets,
labels,
updateTime
FROM google.certificatemanager.certificate_maps
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new CertificateMap in a given project and location.

INSERT INTO google.certificatemanager.certificate_maps (
data__name,
data__description,
data__labels,
projectsId,
locationsId,
certificateMapId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ labels }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ certificateMapId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: certificate_maps
  props:
    - name: projectsId
      value: string
      description: Required parameter for the certificate_maps resource.
    - name: locationsId
      value: string
      description: Required parameter for the certificate_maps resource.
    - name: name
      value: string
      description: >
        Identifier. A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`.
        
    - name: description
      value: string
      description: >
        Optional. One or more paragraphs of text description of a certificate map.
        
    - name: labels
      value: object
      description: >
        Optional. Set of labels associated with a Certificate Map.
        
    - name: certificateMapId
      value: string

UPDATE examples

patch

Updates a CertificateMap.

UPDATE google.certificatemanager.certificate_maps
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__labels = '{{ labels }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND certificateMapsId = '{{ certificateMapsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single CertificateMap. A Certificate Map can't be deleted if it contains Certificate Map Entries. Remove all the entries from the map before calling this method.

DELETE FROM google.certificatemanager.certificate_maps
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND certificateMapsId = '{{ certificateMapsId }}' --required;