contact_centers

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

Overview

Name	contact_centers
Type	Resource
Id	google.contactcenteraiplatform.contact_centers

Fields

Name	Datatype	Description
name	string	name of resource
adminUser	object	Message storing info about the first admin user. Next ID: 3
ccaipManagedUsers	boolean	Optional. Whether to enable users to be created in the CCAIP-instance concurrently to having users in Cloud identity
createTime	string	Output only. [Output only] Create time stamp
critical	object	Instances in this Channel will receive updates after all instances in Normal were updated. They also will only be updated outside of their peak hours.
customerDomainPrefix	string	Required. Immutable. At least 2 and max 16 char long, must conform to RFC 1035.
displayName	string	Required. A user friendly name for the ContactCenter.
early	object	LINT.IfChange First Channel to receive the updates. Meant to dev/test instances
instanceConfig	object	Message storing the instance configuration.
kmsKey	string	Immutable. The KMS key name to encrypt the user input (ContactCenter).
labels	object	Labels as key value pairs
normal	object	Instances in this Channel will receive updates after all instances in Early were updated + 2 days.
privateAccess	object	Defines ingress and egress private traffic settings for CCAIP instances.
privateComponents	array	Output only. TODO(b/283407860) Deprecate this field.
samlParams	object	Message storing SAML params to enable Google as IDP.
state	string	Output only. The state of this contact center.
updateTime	string	Output only. [Output only] Update time stamp
uris	object	Message storing the URIs of the ContactCenter.
userEmail	string	Optional. Email address of the first admin user.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	contactCentersId, locationsId, projectsId	Gets details of a single ContactCenter.
list	SELECT	locationsId, projectsId	Lists ContactCenters in a given project and location.
create	INSERT	locationsId, projectsId	Creates a new ContactCenter in a given project and location.
delete	DELETE	contactCentersId, locationsId, projectsId	Deletes a single ContactCenter.
patch	UPDATE	contactCentersId, locationsId, projectsId	Updates the parameters of a single ContactCenter.

SELECT examples

Lists ContactCenters in a given project and location.

SELECT
name,
adminUser,
ccaipManagedUsers,
createTime,
critical,
customerDomainPrefix,
displayName,
early,
instanceConfig,
kmsKey,
labels,
normal,
privateAccess,
privateComponents,
samlParams,
state,
updateTime,
uris,
userEmail
FROM google.contactcenteraiplatform.contact_centers
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new contact_centers resource.

All Properties

/*+ create */
INSERT INTO google.contactcenteraiplatform.contact_centers (
locationsId,
projectsId,
name,
labels,
customerDomainPrefix,
displayName,
instanceConfig,
samlParams,
userEmail,
ccaipManagedUsers,
adminUser,
kmsKey,
privateAccess,
early,
normal,
critical
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ labels }}',
'{{ customerDomainPrefix }}',
'{{ displayName }}',
'{{ instanceConfig }}',
'{{ samlParams }}',
'{{ userEmail }}',
{{ ccaipManagedUsers }},
'{{ adminUser }}',
'{{ kmsKey }}',
'{{ privateAccess }}',
'{{ early }}',
'{{ normal }}',
'{{ critical }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: labels
      value: object
    - name: uris
      value:
        - name: rootUri
          value: string
        - name: mediaUri
          value: string
        - name: virtualAgentStreamingServiceUri
          value: string
        - name: chatBotUri
          value: string
    - name: state
      value: string
    - name: customerDomainPrefix
      value: string
    - name: displayName
      value: string
    - name: instanceConfig
      value:
        - name: instanceSize
          value: string
    - name: samlParams
      value:
        - name: ssoUri
          value: string
        - name: entityId
          value: string
        - name: certificate
          value: string
        - name: userEmail
          value: string
        - name: emailMapping
          value: string
        - name: authenticationContexts
          value:
            - string
    - name: userEmail
      value: string
    - name: ccaipManagedUsers
      value: boolean
    - name: adminUser
      value:
        - name: givenName
          value: string
        - name: familyName
          value: string
    - name: kmsKey
      value: string
    - name: privateComponents
      value:
        - string
    - name: privateAccess
      value:
        - name: ingressSettings
          value:
            - - name: name
                value: string
              - name: serviceAttachmentNames
                value:
                  - string
        - name: egressSettings
          value:
            - - name: name
                value: string
              - name: serviceAttachmentNames
                value:
                  - string
        - name: pscSetting
          value:
            - name: allowedConsumerProjectIds
              value:
                - string
            - name: producerProjectIds
              value:
                - string
    - name: early
      value: []
    - name: normal
      value: []
    - name: critical
      value:
        - name: peakHours
          value:
            - - name: days
                value:
                  - string
              - name: startTime
                value:
                  - name: hours
                    value: integer
                  - name: minutes
                    value: integer
                  - name: seconds
                    value: integer
                  - name: nanos
                    value: integer
              - name: duration
                value: string

UPDATE example

Updates a contact_centers resource.

/*+ update */
UPDATE google.contactcenteraiplatform.contact_centers
SET 
name = '{{ name }}',
labels = '{{ labels }}',
customerDomainPrefix = '{{ customerDomainPrefix }}',
displayName = '{{ displayName }}',
instanceConfig = '{{ instanceConfig }}',
samlParams = '{{ samlParams }}',
userEmail = '{{ userEmail }}',
ccaipManagedUsers = true|false,
adminUser = '{{ adminUser }}',
kmsKey = '{{ kmsKey }}',
privateAccess = '{{ privateAccess }}',
early = '{{ early }}',
normal = '{{ normal }}',
critical = '{{ critical }}'
WHERE 
contactCentersId = '{{ contactCentersId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified contact_centers resource.

/*+ delete */
DELETE FROM google.contactcenteraiplatform.contact_centers
WHERE contactCentersId = '{{ contactCentersId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';