Class protos.google.cloud.contactcenterinsights.v1.ListConversationsRequest (3.9.0)

Represents a ListConversationsRequest.

Package

@google-cloud/contact-center-insights

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.contactcenterinsights.v1.IListConversationsRequest);

Constructs a new ListConversationsRequest.

Parameter
Name Description
properties IListConversationsRequest

Properties to set

Properties

filter

public filter: string;

ListConversationsRequest filter.

orderBy

public orderBy: string;

ListConversationsRequest orderBy.

pageSize

public pageSize: number;

ListConversationsRequest pageSize.

pageToken

public pageToken: string;

ListConversationsRequest pageToken.

parent

public parent: string;

ListConversationsRequest parent.

view

public view: (google.cloud.contactcenterinsights.v1.ConversationView|keyof typeof google.cloud.contactcenterinsights.v1.ConversationView);

ListConversationsRequest view.

Methods

create(properties)

public static create(properties?: google.cloud.contactcenterinsights.v1.IListConversationsRequest): google.cloud.contactcenterinsights.v1.ListConversationsRequest;

Creates a new ListConversationsRequest instance using the specified properties.

Parameter
Name Description
properties IListConversationsRequest

Properties to set
Returns
Type Description
ListConversationsRequest

ListConversationsRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.contactcenterinsights.v1.ListConversationsRequest;

Decodes a ListConversationsRequest message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
ListConversationsRequest

ListConversationsRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.contactcenterinsights.v1.ListConversationsRequest;

Decodes a ListConversationsRequest message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
ListConversationsRequest

ListConversationsRequest

encode(message, writer)

public static encode(message: google.cloud.contactcenterinsights.v1.IListConversationsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ListConversationsRequest message. Does not implicitly messages.

Parameters
Name Description
message IListConversationsRequest

ListConversationsRequest message or plain object to encode
writer $protobuf.Writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.contactcenterinsights.v1.IListConversationsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ListConversationsRequest message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IListConversationsRequest

ListConversationsRequest message or plain object to encode
writer $protobuf.Writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.contactcenterinsights.v1.ListConversationsRequest;

Creates a ListConversationsRequest message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object
Returns
Type Description
ListConversationsRequest

ListConversationsRequest

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for ListConversationsRequest

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")
Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this ListConversationsRequest to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.contactcenterinsights.v1.ListConversationsRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a ListConversationsRequest message. Also converts values to other types if specified.

Parameters
Name Description
message ListConversationsRequest

ListConversationsRequest
options $protobuf.IConversionOptions

Conversion options
Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a ListConversationsRequest message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not