2023-01-05
▼ ▲ contactcenteraiplatform.projects.queryContactCenterQuota
Flat Path: v1alpha1/projects/{projectsId}:queryContactCenterQuota
Path: v1alpha1/{+parent}:queryContactCenterQuota
HTTP Method: GET
Parameters:
parent
Description: Required. Parent project resource id.
Required: Yes
Pattern: ^projects/[^/]+$
Type: string
Location: path
Parameter Order: parent
Description: Queries the contact center quota, an aggregation over all the projects, that belongs to the billing account, which the input project belongs to.
▼ ▲ contactcenteraiplatform.projects.locations.contactCenters.create
Parameters:
requestId
Location: query
Description: 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 t he 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).
Type: string
parent
Type: string
Description: Required. Value for parent.
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
contactCenterId
Description: 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
Location: query
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha1/{+parent}/contactCenters
Description: Creates a new ContactCenter in a given project and location.
Parameter Order: parent
Flat Path: v1alpha1/projects/{projectsId}/locations/{locationsId}/contactCenters
HTTP Method: POST
▼ ▲ contactcenteraiplatform.projects.locations.contactCenters.get
Parameters:
name
Type: string
Description: Required. Name of the resource
Pattern: ^projects/[^/]+/locations/[^/]+/contactCenters/[^/]+$
Required: Yes
Location: path
Parameter Order: name
Description: Gets details of a single ContactCenter.
Path: v1alpha1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha1/projects/{projectsId}/locations/{locationsId}/contactCenters/{contactCentersId}
HTTP Method: GET
▼ ▲ contactcenteraiplatform.projects.locations.contactCenters.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the parameters of a single ContactCenter.
Flat Path: v1alpha1/projects/{projectsId}/locations/{locationsId}/contactCenters/{contactCentersId}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/contactCenters/[^/]+$
Description: name of resource
Type: string
Location: path
Required: Yes
updateMask
Description: 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.
Type: string
Format: google-fieldmask
Location: query
requestId
Type: string
Description: 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 t he 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).
Location: query
HTTP Method: PATCH
Path: v1alpha1/{+name}
Parameter Order: name
▼ ▲ contactcenteraiplatform.projects.locations.contactCenters.delete
Parameters:
requestId
Description: 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 t he 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).
Type: string
Location: query
name
Description: Required. Name of the resource
Pattern: ^projects/[^/]+/locations/[^/]+/contactCenters/[^/]+$
Location: path
Type: string
Required: Yes
HTTP Method: DELETE
Path: v1alpha1/{+name}
Parameter Order: name
Description: Deletes a single ContactCenter.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha1/projects/{projectsId}/locations/{locationsId}/contactCenters/{contactCentersId}
▼ ▲ contactcenteraiplatform.projects.locations.contactCenters.list
Flat Path: v1alpha1/projects/{projectsId}/locations/{locationsId}/contactCenters
Parameter Order: parent
Path: v1alpha1/{+parent}/contactCenters
Description: Lists ContactCenters in a given project and location.
HTTP Method: GET
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Description: Required. Parent value for ListContactCentersRequest
Type: string
filter
Type: string
Description: Filtering results
Location: query
pageSize
Format: int32
Type: integer
Location: query
Description: Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken
Type: string
Location: query
Description: A token identifying a page of results the server should return.
orderBy
Type: string
Description: Hint for how to order the results
Location: query
▼ ▲ contactcenteraiplatform.projects.locations.operations.delete
Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Parameters:
name
Type: string
Required: Yes
Location: path
Description: The name of the operation resource to be deleted.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Path: v1alpha1/{+name}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Flat Path: v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
▼ ▲ contactcenteraiplatform.projects.locations.operations.get
Flat Path: v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Path: v1alpha1/{+name}
HTTP Method: GET
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters:
name
Type: string
Location: path
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required: Yes
Parameter Order: name
▼ ▲ contactcenteraiplatform.projects.locations.operations.cancel
Flat Path: v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type: string
Required: Yes
Description: The name of the operation resource to be cancelled.
HTTP Method: POST
Parameter Order: name
Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Path: v1alpha1/{+name}:cancel
▼ ▲ contactcenteraiplatform.projects.locations.operations.list
Flat Path: v1alpha1/projects/{projectsId}/locations/{locationsId}/operations
Parameters:
pageSize
Description: The standard list page size.
Type: integer
Location: query
Format: int32
filter
Type: string
Location: query
Description: The standard list filter.
pageToken
Description: The standard list page token.
Location: query
Type: string
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: The name of the operation's parent resource.
Required: Yes
Type: string
Path: v1alpha1/{+name}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
HTTP Method: GET
▼ ▲ contactcenteraiplatform.projects.locations.queryContactCenterQuota
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Pattern: ^projects/[^/]+$
Required: Yes
Location: path
Description: Required. Parent project resource id.
Type: string
locationsId
Location: path
Required: Yes
Type: string
Path: v1alpha1/{+parent}/locations/{locationsId}:queryContactCenterQuota
Description: Queries the contact center quota, an aggregation over all the projects, that belongs to the billing account, which the input project belongs to.
Flat Path: v1alpha1/projects/{projectsId}/locations/{locationsId}:queryContactCenterQuota
Parameter Order:
HTTP Method: GET
▼ ▲ contactcenteraiplatform.projects.locations.get
Flat Path: v1alpha1/projects/{projectsId}/locations/{locationsId}
Parameter Order: name
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets information about a location.
Path: v1alpha1/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Location: path
Required: Yes
Description: Resource name for the location.
▼ ▲ contactcenteraiplatform.projects.locations.list
Parameters:
filter
Type: string
Location: query
Description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
pageToken
Type: string
Location: query
Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
name
Description: The resource that owns the locations collection, if applicable.
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+$
pageSize
Type: integer
Format: int32
Location: query
Description: The maximum number of results to return. If not set, the service selects a default.
Path: v1alpha1/{+name}/locations
Flat Path: v1alpha1/projects/{projectsId}/locations
Parameter Order: name
Description: Lists information about the supported locations for this service.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET