certificate_map_entries

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

Overview

Name	certificate_map_entries
Type	Resource
Id	google.certificatemanager.certificate_map_entries

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 Entry. Certificate Map Entry names must be unique globally and match pattern projects/*/locations/*/certificateMaps/*/certificateMapEntries/*.
certificates	array	Optional. A set of Certificates defines for the given hostname. There can be defined up to four certificates in each Certificate Map Entry. Each certificate must match pattern projects/*/locations/*/certificates/*.
createTime	string (google-datetime)	Output only. The creation timestamp of a Certificate Map Entry.
description	string	Optional. One or more paragraphs of text description of a certificate map entry.
hostname	string	A Hostname (FQDN, e.g. example.com) or a wildcard hostname expression (*.example.com) for a set of hostnames with common suffix. Used as Server Name Indication (SNI) for selecting a proper certificate.
labels	object	Optional. Set of labels associated with a Certificate Map Entry.
matcher	string	A predefined matcher for particular cases, other than SNI selection.
state	string	Output only. A serving state of this Certificate Map Entry.
updateTime	string (google-datetime)	Output only. The update timestamp of a Certificate Map Entry.

list

Successful response

Name	Datatype	Description
name	string	Identifier. A user-defined name of the Certificate Map Entry. Certificate Map Entry names must be unique globally and match pattern projects/*/locations/*/certificateMaps/*/certificateMapEntries/*.
certificates	array	Optional. A set of Certificates defines for the given hostname. There can be defined up to four certificates in each Certificate Map Entry. Each certificate must match pattern projects/*/locations/*/certificates/*.
createTime	string (google-datetime)	Output only. The creation timestamp of a Certificate Map Entry.
description	string	Optional. One or more paragraphs of text description of a certificate map entry.
hostname	string	A Hostname (FQDN, e.g. example.com) or a wildcard hostname expression (*.example.com) for a set of hostnames with common suffix. Used as Server Name Indication (SNI) for selecting a proper certificate.
labels	object	Optional. Set of labels associated with a Certificate Map Entry.
matcher	string	A predefined matcher for particular cases, other than SNI selection.
state	string	Output only. A serving state of this Certificate Map Entry.
updateTime	string (google-datetime)	Output only. The update timestamp of a Certificate Map Entry.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, certificateMapsId, certificateMapEntriesId		Gets details of a single CertificateMapEntry.
list	select	projectsId, locationsId, certificateMapsId	pageSize, pageToken, filter, orderBy	Lists CertificateMapEntries in a given project and location.
create	insert	projectsId, locationsId, certificateMapsId	certificateMapEntryId	Creates a new CertificateMapEntry in a given project and location.
patch	update	projectsId, locationsId, certificateMapsId, certificateMapEntriesId	updateMask	Updates a CertificateMapEntry.
delete	delete	projectsId, locationsId, certificateMapsId, certificateMapEntriesId		Deletes a single CertificateMapEntry.

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

SELECT examples

get

Gets details of a single CertificateMapEntry.

SELECT
name,
certificates,
createTime,
description,
hostname,
labels,
matcher,
state,
updateTime
FROM google.certificatemanager.certificate_map_entries
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND certificateMapsId = '{{ certificateMapsId }}' -- required
AND certificateMapEntriesId = '{{ certificateMapEntriesId }}' -- required;

list

Lists CertificateMapEntries in a given project and location.

SELECT
name,
certificates,
createTime,
description,
hostname,
labels,
matcher,
state,
updateTime
FROM google.certificatemanager.certificate_map_entries
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND certificateMapsId = '{{ certificateMapsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new CertificateMapEntry in a given project and location.

INSERT INTO google.certificatemanager.certificate_map_entries (
data__name,
data__description,
data__labels,
data__hostname,
data__matcher,
data__certificates,
projectsId,
locationsId,
certificateMapsId,
certificateMapEntryId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ labels }}',
'{{ hostname }}',
'{{ matcher }}',
'{{ certificates }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ certificateMapsId }}',
'{{ certificateMapEntryId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: certificate_map_entries
  props:
    - name: projectsId
      value: string
      description: Required parameter for the certificate_map_entries resource.
    - name: locationsId
      value: string
      description: Required parameter for the certificate_map_entries resource.
    - name: certificateMapsId
      value: string
      description: Required parameter for the certificate_map_entries resource.
    - name: name
      value: string
      description: >
        Identifier. A user-defined name of the Certificate Map Entry. Certificate Map Entry names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`.
        
    - name: description
      value: string
      description: >
        Optional. One or more paragraphs of text description of a certificate map entry.
        
    - name: labels
      value: object
      description: >
        Optional. Set of labels associated with a Certificate Map Entry.
        
    - name: hostname
      value: string
      description: >
        A Hostname (FQDN, e.g. `example.com`) or a wildcard hostname expression (`*.example.com`) for a set of hostnames with common suffix. Used as Server Name Indication (SNI) for selecting a proper certificate.
        
    - name: matcher
      value: string
      description: >
        A predefined matcher for particular cases, other than SNI selection.
        
      valid_values: ['MATCHER_UNSPECIFIED', 'PRIMARY']
    - name: certificates
      value: array
      description: >
        Optional. A set of Certificates defines for the given `hostname`. There can be defined up to four certificates in each Certificate Map Entry. Each certificate must match pattern `projects/*/locations/*/certificates/*`.
        
    - name: certificateMapEntryId
      value: string

UPDATE examples

patch

Updates a CertificateMapEntry.

UPDATE google.certificatemanager.certificate_map_entries
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__labels = '{{ labels }}',
data__hostname = '{{ hostname }}',
data__matcher = '{{ matcher }}',
data__certificates = '{{ certificates }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND certificateMapsId = '{{ certificateMapsId }}' --required
AND certificateMapEntriesId = '{{ certificateMapEntriesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single CertificateMapEntry.

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