Google Cloud Contact Center Insights V1 Client - Class ListAnalysesRequest (2.0.0-RC1)

Reference documentation and code samples for the Google Cloud Contact Center Insights V1 Client class ListAnalysesRequest.

The request to list analyses.

Generated from protobuf message google.cloud.contactcenterinsights.v1.ListAnalysesRequest

Namespace

Google \ Cloud \ ContactCenterInsights \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent resource of the analyses.

↳ page_size int

The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty next_page_token in the response indicates that more data is available.

↳ page_token string

The value returned by the last ListAnalysesResponse; indicates that this is a continuation of a prior ListAnalyses call and the system should return the next page of data.

↳ filter string

A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.

getParent

Required. The parent resource of the analyses.

Returns
Type Description
string

setParent

Required. The parent resource of the analyses.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty next_page_token in the response indicates that more data is available.

Returns
Type Description
int

setPageSize

The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty next_page_token in the response indicates that more data is available.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

The value returned by the last ListAnalysesResponse; indicates that this is a continuation of a prior ListAnalyses call and the system should return the next page of data.

Returns
Type Description
string

setPageToken

The value returned by the last ListAnalysesResponse; indicates that this is a continuation of a prior ListAnalyses call and the system should return the next page of data.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.

Returns
Type Description
string

setFilter

A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent resource of the analyses. Please see Google\Cloud\ContactCenterInsights\V1\ContactCenterInsightsClient::conversationName() for help formatting this field.

Returns
Type Description
Google\Cloud\ContactCenterInsights\V1\ListAnalysesRequest