Class protos.google.cloud.contactcenterinsights.v1.IngestConversationsRequest (3.3.0)

Represents an IngestConversationsRequest.

Package

@google-cloud/contact-center-insights

Constructors

(constructor)(properties)

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

Constructs a new IngestConversationsRequest.

Parameter
NameDescription
properties IIngestConversationsRequest

Properties to set

Properties

conversationConfig

public conversationConfig?: (google.cloud.contactcenterinsights.v1.IngestConversationsRequest.IConversationConfig|null);

IngestConversationsRequest conversationConfig.

gcsSource

public gcsSource?: (google.cloud.contactcenterinsights.v1.IngestConversationsRequest.IGcsSource|null);

IngestConversationsRequest gcsSource.

objectConfig

public objectConfig?: "transcriptObjectConfig";

IngestConversationsRequest objectConfig.

parent

public parent: string;

IngestConversationsRequest parent.

redactionConfig

public redactionConfig?: (google.cloud.contactcenterinsights.v1.IRedactionConfig|null);

IngestConversationsRequest redactionConfig.

source

public source?: "gcsSource";

IngestConversationsRequest source.

speechConfig

public speechConfig?: (google.cloud.contactcenterinsights.v1.ISpeechConfig|null);

IngestConversationsRequest speechConfig.

transcriptObjectConfig

public transcriptObjectConfig?: (google.cloud.contactcenterinsights.v1.IngestConversationsRequest.ITranscriptObjectConfig|null);

IngestConversationsRequest transcriptObjectConfig.

Methods

create(properties)

public static create(properties?: google.cloud.contactcenterinsights.v1.IIngestConversationsRequest): google.cloud.contactcenterinsights.v1.IngestConversationsRequest;

Creates a new IngestConversationsRequest instance using the specified properties.

Parameter
NameDescription
properties IIngestConversationsRequest

Properties to set

Returns
TypeDescription
IngestConversationsRequest

IngestConversationsRequest instance

decode(reader, length)

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

Decodes an IngestConversationsRequest message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
IngestConversationsRequest

IngestConversationsRequest

decodeDelimited(reader)

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

Decodes an IngestConversationsRequest message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
IngestConversationsRequest

IngestConversationsRequest

encode(message, writer)

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

Encodes the specified IngestConversationsRequest message. Does not implicitly messages.

Parameters
NameDescription
message IIngestConversationsRequest

IngestConversationsRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IIngestConversationsRequest

IngestConversationsRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
IngestConversationsRequest

IngestConversationsRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for IngestConversationsRequest

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this IngestConversationsRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message IngestConversationsRequest

IngestConversationsRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an IngestConversationsRequest message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not