contact_centers

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

Overview

Name	contact_centers
Type	Resource
Id	google.contactcenteraiplatform.contact_centers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	name of resource
adminUser	object	Optional. Info about the first admin user, such as given name and family name. (id: AdminUser)
advancedReportingEnabled	boolean	Optional. Whether the advanced reporting feature is enabled.
ccaipManagedUsers	boolean	Optional. Whether to enable users to be created in the CCAIP-instance concurrently to having users in Cloud identity
createTime	string (google-datetime)	Output only. [Output only] Create time stamp
critical	object	Optional. Critical release channel. (id: Critical)
customerDomainPrefix	string	Required. Immutable. At least 2 and max 16 char long, must conform to RFC 1035.
deleteTime	string (google-datetime)	Output only. Timestamp in UTC of when this resource was soft-deleted.
displayName	string	Required. A user friendly name for the ContactCenter.
early	object	Optional. Early release channel. (id: Early)
expireTime	string (google-datetime)	Output only. Timestamp in UTC of when this resource is considered expired.
featureConfig	object	Optional. Feature configuration to populate the feature flags. (id: FeatureConfig)
instanceConfig	object	The configuration of this instance, it is currently immutable once created. (id: InstanceConfig)
kmsKey	string	Immutable. The KMS key name to encrypt the user input (ContactCenter).
labels	object	Labels as key value pairs
normal	object	Optional. Normal release channel. (id: Normal)
privateAccess	object	Optional. VPC-SC related networking configuration. (id: PrivateAccess)
privateComponents	array	Output only. TODO(b/283407860) Deprecate this field.
purgeTime	string (google-datetime)	Output only. Timestamp in UTC of when this resource is going to be hard-deleted.
releaseVersion	string	Output only. UJET release version, unique for each new release.
samlParams	object	Optional. Params that sets up Google as IdP. (id: SAMLParams)
state	string	Output only. The state of this contact center. (STATE_UNSPECIFIED, STATE_DEPLOYING, STATE_DEPLOYED, STATE_TERMINATING, STATE_FAILED, STATE_TERMINATING_FAILED, STATE_TERMINATED, STATE_IN_GRACE_PERIOD, STATE_FAILING_OVER, STATE_DEGRADED, STATE_REPAIRING, STATE_EXPIRING)
updateTime	string (google-datetime)	Output only. [Output only] Update time stamp
uris	object	Output only. URIs to access the deployed ContactCenters. (id: URIs)
userEmail	string	Optional. Email address of the first admin user.

list

Name	Datatype	Description
name	string	name of resource
adminUser	object	Optional. Info about the first admin user, such as given name and family name. (id: AdminUser)
advancedReportingEnabled	boolean	Optional. Whether the advanced reporting feature is enabled.
ccaipManagedUsers	boolean	Optional. Whether to enable users to be created in the CCAIP-instance concurrently to having users in Cloud identity
createTime	string (google-datetime)	Output only. [Output only] Create time stamp
critical	object	Optional. Critical release channel. (id: Critical)
customerDomainPrefix	string	Required. Immutable. At least 2 and max 16 char long, must conform to RFC 1035.
deleteTime	string (google-datetime)	Output only. Timestamp in UTC of when this resource was soft-deleted.
displayName	string	Required. A user friendly name for the ContactCenter.
early	object	Optional. Early release channel. (id: Early)
expireTime	string (google-datetime)	Output only. Timestamp in UTC of when this resource is considered expired.
featureConfig	object	Optional. Feature configuration to populate the feature flags. (id: FeatureConfig)
instanceConfig	object	The configuration of this instance, it is currently immutable once created. (id: InstanceConfig)
kmsKey	string	Immutable. The KMS key name to encrypt the user input (ContactCenter).
labels	object	Labels as key value pairs
normal	object	Optional. Normal release channel. (id: Normal)
privateAccess	object	Optional. VPC-SC related networking configuration. (id: PrivateAccess)
privateComponents	array	Output only. TODO(b/283407860) Deprecate this field.
purgeTime	string (google-datetime)	Output only. Timestamp in UTC of when this resource is going to be hard-deleted.
releaseVersion	string	Output only. UJET release version, unique for each new release.
samlParams	object	Optional. Params that sets up Google as IdP. (id: SAMLParams)
state	string	Output only. The state of this contact center. (STATE_UNSPECIFIED, STATE_DEPLOYING, STATE_DEPLOYED, STATE_TERMINATING, STATE_FAILED, STATE_TERMINATING_FAILED, STATE_TERMINATED, STATE_IN_GRACE_PERIOD, STATE_FAILING_OVER, STATE_DEGRADED, STATE_REPAIRING, STATE_EXPIRING)
updateTime	string (google-datetime)	Output only. [Output only] Update time stamp
uris	object	Output only. URIs to access the deployed ContactCenters. (id: URIs)
userEmail	string	Optional. Email address of the first admin user.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, contactCentersId		Gets details of a single ContactCenter.
list	select	projectsId, locationsId	pageToken, pageSize, filter, orderBy	Lists ContactCenters in a given project and location.
create	insert	projectsId, locationsId	contactCenterId, requestId	Creates a new ContactCenter in a given project and location.
patch	update	projectsId, locationsId, contactCentersId	requestId, updateMask	Updates the parameters of a single ContactCenter.
delete	delete	projectsId, locationsId, contactCentersId	requestId	Deletes a single ContactCenter.

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

SELECT examples

get

Gets details of a single ContactCenter.

SELECT
name,
adminUser,
advancedReportingEnabled,
ccaipManagedUsers,
createTime,
critical,
customerDomainPrefix,
deleteTime,
displayName,
early,
expireTime,
featureConfig,
instanceConfig,
kmsKey,
labels,
normal,
privateAccess,
privateComponents,
purgeTime,
releaseVersion,
samlParams,
state,
updateTime,
uris,
userEmail
FROM google.contactcenteraiplatform.contact_centers
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND contactCentersId = '{{ contactCentersId }}' -- required
;

list

Lists ContactCenters in a given project and location.

SELECT
name,
adminUser,
advancedReportingEnabled,
ccaipManagedUsers,
createTime,
critical,
customerDomainPrefix,
deleteTime,
displayName,
early,
expireTime,
featureConfig,
instanceConfig,
kmsKey,
labels,
normal,
privateAccess,
privateComponents,
purgeTime,
releaseVersion,
samlParams,
state,
updateTime,
uris,
userEmail
FROM google.contactcenteraiplatform.contact_centers
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Creates a new ContactCenter in a given project and location.

INSERT INTO google.contactcenteraiplatform.contact_centers (
data__adminUser,
data__kmsKey,
data__samlParams,
data__userEmail,
data__featureConfig,
data__instanceConfig,
data__name,
data__labels,
data__displayName,
data__critical,
data__early,
data__customerDomainPrefix,
data__advancedReportingEnabled,
data__ccaipManagedUsers,
data__privateAccess,
data__normal,
projectsId,
locationsId,
contactCenterId,
requestId
)
SELECT 
'{{ adminUser }}',
'{{ kmsKey }}',
'{{ samlParams }}',
'{{ userEmail }}',
'{{ featureConfig }}',
'{{ instanceConfig }}',
'{{ name }}',
'{{ labels }}',
'{{ displayName }}',
'{{ critical }}',
'{{ early }}',
'{{ customerDomainPrefix }}',
{{ advancedReportingEnabled }},
{{ ccaipManagedUsers }},
'{{ privateAccess }}',
'{{ normal }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ contactCenterId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: contact_centers
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the contact_centers resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the contact_centers resource.
  - name: adminUser
    description: |
      Optional. Info about the first admin user, such as given name and family name.
    value:
      givenName: "{{ givenName }}"
      familyName: "{{ familyName }}"
  - name: kmsKey
    value: "{{ kmsKey }}"
    description: |
      Immutable. The KMS key name to encrypt the user input (`ContactCenter`).
  - name: samlParams
    description: |
      Optional. Params that sets up Google as IdP.
    value:
      authenticationContexts:
        - "{{ authenticationContexts }}"
      certificate: "{{ certificate }}"
      userEmail: "{{ userEmail }}"
      emailMapping: "{{ emailMapping }}"
      ssoUri: "{{ ssoUri }}"
      entityId: "{{ entityId }}"
  - name: userEmail
    value: "{{ userEmail }}"
    description: |
      Optional. Email address of the first admin user.
  - name: featureConfig
    description: |
      Optional. Feature configuration to populate the feature flags.
    value:
      agentDesktopEnabled: {{ agentDesktopEnabled }}
  - name: instanceConfig
    description: |
      The configuration of this instance, it is currently immutable once created.
    value:
      instanceSize: "{{ instanceSize }}"
  - name: name
    value: "{{ name }}"
    description: |
      name of resource
  - name: labels
    value: "{{ labels }}"
    description: |
      Labels as key value pairs
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Required. A user friendly name for the ContactCenter.
  - name: critical
    description: |
      Optional. Critical release channel.
    value:
      peakHours:
        - startTime:
            hours: {{ hours }}
            minutes: {{ minutes }}
            seconds: {{ seconds }}
            nanos: {{ nanos }}
          endTime:
            hours: {{ hours }}
            minutes: {{ minutes }}
            seconds: {{ seconds }}
            nanos: {{ nanos }}
          days: "{{ days }}"
          duration: "{{ duration }}"
  - name: early
    value: "{{ early }}"
    description: |
      Optional. Early release channel.
  - name: customerDomainPrefix
    value: "{{ customerDomainPrefix }}"
    description: |
      Required. Immutable. At least 2 and max 16 char long, must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
  - name: advancedReportingEnabled
    value: {{ advancedReportingEnabled }}
    description: |
      Optional. Whether the advanced reporting feature is enabled.
  - name: ccaipManagedUsers
    value: {{ ccaipManagedUsers }}
    description: |
      Optional. Whether to enable users to be created in the CCAIP-instance concurrently to having users in Cloud identity
  - name: privateAccess
    description: |
      Optional. VPC-SC related networking configuration.
    value:
      ingressSettings:
        - name: "{{ name }}"
          serviceAttachmentNames: "{{ serviceAttachmentNames }}"
      pscSetting:
        allowedConsumerProjectIds:
          - "{{ allowedConsumerProjectIds }}"
        producerProjectIds:
          - "{{ producerProjectIds }}"
      egressSettings:
        - name: "{{ name }}"
          serviceAttachmentNames: "{{ serviceAttachmentNames }}"
  - name: normal
    value: "{{ normal }}"
    description: |
      Optional. Normal release channel.
  - name: contactCenterId
    value: "{{ contactCenterId }}"
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Updates the parameters of a single ContactCenter.

UPDATE google.contactcenteraiplatform.contact_centers
SET 
data__adminUser = '{{ adminUser }}',
data__kmsKey = '{{ kmsKey }}',
data__samlParams = '{{ samlParams }}',
data__userEmail = '{{ userEmail }}',
data__featureConfig = '{{ featureConfig }}',
data__instanceConfig = '{{ instanceConfig }}',
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__displayName = '{{ displayName }}',
data__critical = '{{ critical }}',
data__early = '{{ early }}',
data__customerDomainPrefix = '{{ customerDomainPrefix }}',
data__advancedReportingEnabled = {{ advancedReportingEnabled }},
data__ccaipManagedUsers = {{ ccaipManagedUsers }},
data__privateAccess = '{{ privateAccess }}',
data__normal = '{{ normal }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND contactCentersId = '{{ contactCentersId }}' --required
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single ContactCenter.

DELETE FROM google.contactcenteraiplatform.contact_centers
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND contactCentersId = '{{ contactCentersId }}' --required
AND requestId = '{{ requestId }}'
;