Cloud Speech V2 Client - Class ListCustomClassesRequest (1.7.0)

Reference documentation and code samples for the Cloud Speech V2 Client class ListCustomClassesRequest.

Request message for the ListCustomClasses method.

Generated from protobuf message google.cloud.speech.v2.ListCustomClassesRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The project and location of CustomClass resources to list. The expected format is projects/{project}/locations/{location}.

↳ page_size int

Number of results per requests. A valid page_size ranges from 0 to 20 inclusive. If the page_size is zero or unspecified, a page size of 5 will be chosen. If the page size exceeds 20, it will be coerced down to 20. Note that a call might return fewer results than the requested page size.

↳ page_token string

A page token, received from a previous ListCustomClasses call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListCustomClasses must match the call that provided the page token.

↳ show_deleted bool

Whether, or not, to show resources that have been deleted.

getParent

Required. The project and location of CustomClass resources to list. The expected format is projects/{project}/locations/{location}.

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
TypeDescription
string

setParent

Required. The project and location of CustomClass resources to list. The expected format is projects/{project}/locations/{location}.

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

Number of results per requests. A valid page_size ranges from 0 to 20 inclusive. If the page_size is zero or unspecified, a page size of 5 will be chosen. If the page size exceeds 20, it will be coerced down to 20. Note that a call might return fewer results than the requested page size.

Generated from protobuf field int32 page_size = 2;

Returns
TypeDescription
int

setPageSize

Number of results per requests. A valid page_size ranges from 0 to 20 inclusive. If the page_size is zero or unspecified, a page size of 5 will be chosen. If the page size exceeds 20, it will be coerced down to 20. Note that a call might return fewer results than the requested page size.

Generated from protobuf field int32 page_size = 2;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

A page token, received from a previous ListCustomClasses call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListCustomClasses must match the call that provided the page token.

Generated from protobuf field string page_token = 3;

Returns
TypeDescription
string

setPageToken

A page token, received from a previous ListCustomClasses call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListCustomClasses must match the call that provided the page token.

Generated from protobuf field string page_token = 3;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getShowDeleted

Whether, or not, to show resources that have been deleted.

Generated from protobuf field bool show_deleted = 4;

Returns
TypeDescription
bool

setShowDeleted

Whether, or not, to show resources that have been deleted.

Generated from protobuf field bool show_deleted = 4;

Parameter
NameDescription
var bool
Returns
TypeDescription
$this