Reference documentation and code samples for the Google Cloud Contact Center Insights V1 Client class BulkDeleteConversationsRequest.
The request to delete conversations in bulk.
Generated from protobuf message google.cloud.contactcenterinsights.v1.BulkDeleteConversationsRequest
Namespace
Google \ Cloud \ ContactCenterInsights \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location} |
↳ filter |
string
Filter used to select the subset of conversations to delete. |
↳ max_delete_count |
int
Maximum number of conversations to delete. |
↳ force |
bool
If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses. |
getParent
Required. The parent resource to delete conversations from.
Format: projects/{project}/locations/{location}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent resource to delete conversations from.
Format: projects/{project}/locations/{location}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Filter used to select the subset of conversations to delete.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Filter used to select the subset of conversations to delete.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxDeleteCount
Maximum number of conversations to delete.
| Returns | |
|---|---|
| Type | Description |
int |
|
setMaxDeleteCount
Maximum number of conversations to delete.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getForce
If set to true, all of this conversation's analyses will also be deleted.
Otherwise, the request will only succeed if the conversation has no analyses.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setForce
If set to true, all of this conversation's analyses will also be deleted.
Otherwise, the request will only succeed if the conversation has no analyses.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location} Please see Google\Cloud\ContactCenterInsights\V1\ContactCenterInsightsClient::locationName() for help formatting this field. |
filter |
string
Filter used to select the subset of conversations to delete. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\ContactCenterInsights\V1\BulkDeleteConversationsRequest |
|