Close httplib2 connections.
create(parent, body=None, contactCenterId=None, requestId=None, x__xgafv=None)
Creates a new ContactCenter in a given project and location.
delete(name, requestId=None, x__xgafv=None)
Deletes a single ContactCenter.
Gets details of a single ContactCenter.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists ContactCenters in a given project and location.
Retrieves the next page of results.
patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
Updates the parameters of a single ContactCenter.
close()
Close httplib2 connections.
create(parent, body=None, contactCenterId=None, requestId=None, x__xgafv=None)
Creates a new ContactCenter in a given project and location.
Args:
parent: string, Required. Value for parent. (required)
body: object, The request body.
The object takes the form of:
{ # Message describing ContactCenter object Next ID: 24
"adminUser": { # Message storing info about the first admin user. Next ID: 3 # Optional. Info about the first admin user, such as given name and family name.
"familyName": "A String", # Optional. Last/family name of the first admin user.
"givenName": "A String", # Optional. First/given name of the first admin user.
},
"ccaipManagedUsers": True or False, # Optional. Whether to enable users to be created in the CCAIP-instance concurrently to having users in Cloud identity
"createTime": "A String", # Output only. [Output only] Create time stamp
"critical": { # 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. # Optional. Critical release channel.
"peakHours": [ # Required. Hours during which the instance should not be updated.
{ # Message representing a weekly schedule.
"days": [ # Required. Days of the week this schedule applies to.
"A String",
],
"duration": "A String", # Optional. Duration of the schedule.
"endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Daily end time of the schedule. If `end_time` is before `start_time`, the schedule will be considered as ending on the next day.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Daily start time of the schedule.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
},
"customerDomainPrefix": "A String", # Required. Immutable. At least 2 and max 16 char long, must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
"displayName": "A String", # Required. A user friendly name for the ContactCenter.
"early": { # LINT.IfChange First Channel to receive the updates. Meant to dev/test instances # Optional. Early release channel.
},
"instanceConfig": { # Message storing the instance configuration. # The configuration of this instance, it is currently immutable once created.
"instanceSize": "A String", # The instance size of this the instance configuration.
},
"kmsKey": "A String", # Immutable. The KMS key name to encrypt the user input (`ContactCenter`).
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"name": "A String", # name of resource
"normal": { # Instances in this Channel will receive updates after all instances in `Early` were updated + 2 days. # Optional. Normal release channel.
},
"privateAccess": { # Defines ingress and egress private traffic settings for CCAIP instances. # Optional. VPC-SC related networking configuration.
"egressSettings": [ # List of egress components that should not be accessed via the Internet. For more information see go/ccaip-private-path-v2.
{ # Defines a logical CCAIP component that e.g. “EMAIL”, "CRM". For more information see go/ccaip-private-path-v2. Each logical component is associated with a list of service attachments.
"name": "A String", # Name of the component.
"serviceAttachmentNames": [ # Associated service attachments. The service attachment names that will be used for sending private traffic to the CCAIP tenant project. Example service attachment name: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default".
"A String",
],
},
],
"ingressSettings": [ # List of ingress components that should not be accessed via the Internet. For more information see go/ccaip-private-path-v2.
{ # Defines a logical CCAIP component that e.g. “EMAIL”, "CRM". For more information see go/ccaip-private-path-v2. Each logical component is associated with a list of service attachments.
"name": "A String", # Name of the component.
"serviceAttachmentNames": [ # Associated service attachments. The service attachment names that will be used for sending private traffic to the CCAIP tenant project. Example service attachment name: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default".
"A String",
],
},
],
"pscSetting": { # Private service connect settings. # Private service connect settings.
"allowedConsumerProjectIds": [ # The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress components.
"A String",
],
"producerProjectIds": [ # Output only. The CCAIP tenant project ids.
"A String",
],
},
},
"privateComponents": [ # Output only. TODO(b/283407860) Deprecate this field.
"A String",
],
"samlParams": { # Message storing SAML params to enable Google as IDP. # Optional. Params that sets up Google as IdP.
"authenticationContexts": [ # Additional contexts used for authentication.
"A String",
],
"certificate": "A String", # SAML certificate
"emailMapping": "A String", # IdP field that maps to the user’s email address
"entityId": "A String", # Entity id URL
"ssoUri": "A String", # Single sign-on URL
"userEmail": "A String", # Email address of the first admin users.
},
"state": "A String", # Output only. The state of this contact center.
"updateTime": "A String", # Output only. [Output only] Update time stamp
"uris": { # Message storing the URIs of the ContactCenter. # Output only. URIs to access the deployed ContactCenters.
"chatBotUri": "A String", # Chat Bot Uri of the ContactCenter
"mediaUri": "A String", # Media Uri of the ContactCenter.
"rootUri": "A String", # Root Uri of the ContactCenter.
"virtualAgentStreamingServiceUri": "A String", # Virtual Agent Streaming Service Uri of the ContactCenter.
},
"userEmail": "A String", # Optional. Email address of the first admin user.
}
contactCenterId: string, Required. Id of the requesting object If auto-generating Id server-side, remove this field and contact_center_id from the method_signature of Create RPC
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
delete(name, requestId=None, x__xgafv=None)
Deletes a single ContactCenter.
Args:
name: string, Required. Name of the resource (required)
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, x__xgafv=None)
Gets details of a single ContactCenter.
Args:
name: string, Required. Name of the resource (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message describing ContactCenter object Next ID: 24
"adminUser": { # Message storing info about the first admin user. Next ID: 3 # Optional. Info about the first admin user, such as given name and family name.
"familyName": "A String", # Optional. Last/family name of the first admin user.
"givenName": "A String", # Optional. First/given name of the first admin user.
},
"ccaipManagedUsers": True or False, # Optional. Whether to enable users to be created in the CCAIP-instance concurrently to having users in Cloud identity
"createTime": "A String", # Output only. [Output only] Create time stamp
"critical": { # 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. # Optional. Critical release channel.
"peakHours": [ # Required. Hours during which the instance should not be updated.
{ # Message representing a weekly schedule.
"days": [ # Required. Days of the week this schedule applies to.
"A String",
],
"duration": "A String", # Optional. Duration of the schedule.
"endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Daily end time of the schedule. If `end_time` is before `start_time`, the schedule will be considered as ending on the next day.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Daily start time of the schedule.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
},
"customerDomainPrefix": "A String", # Required. Immutable. At least 2 and max 16 char long, must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
"displayName": "A String", # Required. A user friendly name for the ContactCenter.
"early": { # LINT.IfChange First Channel to receive the updates. Meant to dev/test instances # Optional. Early release channel.
},
"instanceConfig": { # Message storing the instance configuration. # The configuration of this instance, it is currently immutable once created.
"instanceSize": "A String", # The instance size of this the instance configuration.
},
"kmsKey": "A String", # Immutable. The KMS key name to encrypt the user input (`ContactCenter`).
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"name": "A String", # name of resource
"normal": { # Instances in this Channel will receive updates after all instances in `Early` were updated + 2 days. # Optional. Normal release channel.
},
"privateAccess": { # Defines ingress and egress private traffic settings for CCAIP instances. # Optional. VPC-SC related networking configuration.
"egressSettings": [ # List of egress components that should not be accessed via the Internet. For more information see go/ccaip-private-path-v2.
{ # Defines a logical CCAIP component that e.g. “EMAIL”, "CRM". For more information see go/ccaip-private-path-v2. Each logical component is associated with a list of service attachments.
"name": "A String", # Name of the component.
"serviceAttachmentNames": [ # Associated service attachments. The service attachment names that will be used for sending private traffic to the CCAIP tenant project. Example service attachment name: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default".
"A String",
],
},
],
"ingressSettings": [ # List of ingress components that should not be accessed via the Internet. For more information see go/ccaip-private-path-v2.
{ # Defines a logical CCAIP component that e.g. “EMAIL”, "CRM". For more information see go/ccaip-private-path-v2. Each logical component is associated with a list of service attachments.
"name": "A String", # Name of the component.
"serviceAttachmentNames": [ # Associated service attachments. The service attachment names that will be used for sending private traffic to the CCAIP tenant project. Example service attachment name: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default".
"A String",
],
},
],
"pscSetting": { # Private service connect settings. # Private service connect settings.
"allowedConsumerProjectIds": [ # The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress components.
"A String",
],
"producerProjectIds": [ # Output only. The CCAIP tenant project ids.
"A String",
],
},
},
"privateComponents": [ # Output only. TODO(b/283407860) Deprecate this field.
"A String",
],
"samlParams": { # Message storing SAML params to enable Google as IDP. # Optional. Params that sets up Google as IdP.
"authenticationContexts": [ # Additional contexts used for authentication.
"A String",
],
"certificate": "A String", # SAML certificate
"emailMapping": "A String", # IdP field that maps to the user’s email address
"entityId": "A String", # Entity id URL
"ssoUri": "A String", # Single sign-on URL
"userEmail": "A String", # Email address of the first admin users.
},
"state": "A String", # Output only. The state of this contact center.
"updateTime": "A String", # Output only. [Output only] Update time stamp
"uris": { # Message storing the URIs of the ContactCenter. # Output only. URIs to access the deployed ContactCenters.
"chatBotUri": "A String", # Chat Bot Uri of the ContactCenter
"mediaUri": "A String", # Media Uri of the ContactCenter.
"rootUri": "A String", # Root Uri of the ContactCenter.
"virtualAgentStreamingServiceUri": "A String", # Virtual Agent Streaming Service Uri of the ContactCenter.
},
"userEmail": "A String", # Optional. Email address of the first admin user.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists ContactCenters in a given project and location.
Args:
parent: string, Required. Parent value for ListContactCentersRequest (required)
filter: string, Filtering results
orderBy: string, Hint for how to order the results
pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for response to listing ContactCenters
"contactCenters": [ # The list of ContactCenter
{ # Message describing ContactCenter object Next ID: 24
"adminUser": { # Message storing info about the first admin user. Next ID: 3 # Optional. Info about the first admin user, such as given name and family name.
"familyName": "A String", # Optional. Last/family name of the first admin user.
"givenName": "A String", # Optional. First/given name of the first admin user.
},
"ccaipManagedUsers": True or False, # Optional. Whether to enable users to be created in the CCAIP-instance concurrently to having users in Cloud identity
"createTime": "A String", # Output only. [Output only] Create time stamp
"critical": { # 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. # Optional. Critical release channel.
"peakHours": [ # Required. Hours during which the instance should not be updated.
{ # Message representing a weekly schedule.
"days": [ # Required. Days of the week this schedule applies to.
"A String",
],
"duration": "A String", # Optional. Duration of the schedule.
"endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Daily end time of the schedule. If `end_time` is before `start_time`, the schedule will be considered as ending on the next day.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Daily start time of the schedule.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
},
"customerDomainPrefix": "A String", # Required. Immutable. At least 2 and max 16 char long, must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
"displayName": "A String", # Required. A user friendly name for the ContactCenter.
"early": { # LINT.IfChange First Channel to receive the updates. Meant to dev/test instances # Optional. Early release channel.
},
"instanceConfig": { # Message storing the instance configuration. # The configuration of this instance, it is currently immutable once created.
"instanceSize": "A String", # The instance size of this the instance configuration.
},
"kmsKey": "A String", # Immutable. The KMS key name to encrypt the user input (`ContactCenter`).
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"name": "A String", # name of resource
"normal": { # Instances in this Channel will receive updates after all instances in `Early` were updated + 2 days. # Optional. Normal release channel.
},
"privateAccess": { # Defines ingress and egress private traffic settings for CCAIP instances. # Optional. VPC-SC related networking configuration.
"egressSettings": [ # List of egress components that should not be accessed via the Internet. For more information see go/ccaip-private-path-v2.
{ # Defines a logical CCAIP component that e.g. “EMAIL”, "CRM". For more information see go/ccaip-private-path-v2. Each logical component is associated with a list of service attachments.
"name": "A String", # Name of the component.
"serviceAttachmentNames": [ # Associated service attachments. The service attachment names that will be used for sending private traffic to the CCAIP tenant project. Example service attachment name: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default".
"A String",
],
},
],
"ingressSettings": [ # List of ingress components that should not be accessed via the Internet. For more information see go/ccaip-private-path-v2.
{ # Defines a logical CCAIP component that e.g. “EMAIL”, "CRM". For more information see go/ccaip-private-path-v2. Each logical component is associated with a list of service attachments.
"name": "A String", # Name of the component.
"serviceAttachmentNames": [ # Associated service attachments. The service attachment names that will be used for sending private traffic to the CCAIP tenant project. Example service attachment name: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default".
"A String",
],
},
],
"pscSetting": { # Private service connect settings. # Private service connect settings.
"allowedConsumerProjectIds": [ # The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress components.
"A String",
],
"producerProjectIds": [ # Output only. The CCAIP tenant project ids.
"A String",
],
},
},
"privateComponents": [ # Output only. TODO(b/283407860) Deprecate this field.
"A String",
],
"samlParams": { # Message storing SAML params to enable Google as IDP. # Optional. Params that sets up Google as IdP.
"authenticationContexts": [ # Additional contexts used for authentication.
"A String",
],
"certificate": "A String", # SAML certificate
"emailMapping": "A String", # IdP field that maps to the user’s email address
"entityId": "A String", # Entity id URL
"ssoUri": "A String", # Single sign-on URL
"userEmail": "A String", # Email address of the first admin users.
},
"state": "A String", # Output only. The state of this contact center.
"updateTime": "A String", # Output only. [Output only] Update time stamp
"uris": { # Message storing the URIs of the ContactCenter. # Output only. URIs to access the deployed ContactCenters.
"chatBotUri": "A String", # Chat Bot Uri of the ContactCenter
"mediaUri": "A String", # Media Uri of the ContactCenter.
"rootUri": "A String", # Root Uri of the ContactCenter.
"virtualAgentStreamingServiceUri": "A String", # Virtual Agent Streaming Service Uri of the ContactCenter.
},
"userEmail": "A String", # Optional. Email address of the first admin user.
},
],
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
Updates the parameters of a single ContactCenter.
Args:
name: string, name of resource (required)
body: object, The request body.
The object takes the form of:
{ # Message describing ContactCenter object Next ID: 24
"adminUser": { # Message storing info about the first admin user. Next ID: 3 # Optional. Info about the first admin user, such as given name and family name.
"familyName": "A String", # Optional. Last/family name of the first admin user.
"givenName": "A String", # Optional. First/given name of the first admin user.
},
"ccaipManagedUsers": True or False, # Optional. Whether to enable users to be created in the CCAIP-instance concurrently to having users in Cloud identity
"createTime": "A String", # Output only. [Output only] Create time stamp
"critical": { # 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. # Optional. Critical release channel.
"peakHours": [ # Required. Hours during which the instance should not be updated.
{ # Message representing a weekly schedule.
"days": [ # Required. Days of the week this schedule applies to.
"A String",
],
"duration": "A String", # Optional. Duration of the schedule.
"endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Daily end time of the schedule. If `end_time` is before `start_time`, the schedule will be considered as ending on the next day.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Daily start time of the schedule.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
},
"customerDomainPrefix": "A String", # Required. Immutable. At least 2 and max 16 char long, must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
"displayName": "A String", # Required. A user friendly name for the ContactCenter.
"early": { # LINT.IfChange First Channel to receive the updates. Meant to dev/test instances # Optional. Early release channel.
},
"instanceConfig": { # Message storing the instance configuration. # The configuration of this instance, it is currently immutable once created.
"instanceSize": "A String", # The instance size of this the instance configuration.
},
"kmsKey": "A String", # Immutable. The KMS key name to encrypt the user input (`ContactCenter`).
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"name": "A String", # name of resource
"normal": { # Instances in this Channel will receive updates after all instances in `Early` were updated + 2 days. # Optional. Normal release channel.
},
"privateAccess": { # Defines ingress and egress private traffic settings for CCAIP instances. # Optional. VPC-SC related networking configuration.
"egressSettings": [ # List of egress components that should not be accessed via the Internet. For more information see go/ccaip-private-path-v2.
{ # Defines a logical CCAIP component that e.g. “EMAIL”, "CRM". For more information see go/ccaip-private-path-v2. Each logical component is associated with a list of service attachments.
"name": "A String", # Name of the component.
"serviceAttachmentNames": [ # Associated service attachments. The service attachment names that will be used for sending private traffic to the CCAIP tenant project. Example service attachment name: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default".
"A String",
],
},
],
"ingressSettings": [ # List of ingress components that should not be accessed via the Internet. For more information see go/ccaip-private-path-v2.
{ # Defines a logical CCAIP component that e.g. “EMAIL”, "CRM". For more information see go/ccaip-private-path-v2. Each logical component is associated with a list of service attachments.
"name": "A String", # Name of the component.
"serviceAttachmentNames": [ # Associated service attachments. The service attachment names that will be used for sending private traffic to the CCAIP tenant project. Example service attachment name: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default".
"A String",
],
},
],
"pscSetting": { # Private service connect settings. # Private service connect settings.
"allowedConsumerProjectIds": [ # The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress components.
"A String",
],
"producerProjectIds": [ # Output only. The CCAIP tenant project ids.
"A String",
],
},
},
"privateComponents": [ # Output only. TODO(b/283407860) Deprecate this field.
"A String",
],
"samlParams": { # Message storing SAML params to enable Google as IDP. # Optional. Params that sets up Google as IdP.
"authenticationContexts": [ # Additional contexts used for authentication.
"A String",
],
"certificate": "A String", # SAML certificate
"emailMapping": "A String", # IdP field that maps to the user’s email address
"entityId": "A String", # Entity id URL
"ssoUri": "A String", # Single sign-on URL
"userEmail": "A String", # Email address of the first admin users.
},
"state": "A String", # Output only. The state of this contact center.
"updateTime": "A String", # Output only. [Output only] Update time stamp
"uris": { # Message storing the URIs of the ContactCenter. # Output only. URIs to access the deployed ContactCenters.
"chatBotUri": "A String", # Chat Bot Uri of the ContactCenter
"mediaUri": "A String", # Media Uri of the ContactCenter.
"rootUri": "A String", # Root Uri of the ContactCenter.
"virtualAgentStreamingServiceUri": "A String", # Virtual Agent Streaming Service Uri of the ContactCenter.
},
"userEmail": "A String", # Optional. Email address of the first admin user.
}
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the ContactCenter resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}