Represents a Case.
Package
@google-cloud/supportConstructors
(constructor)(properties)
constructor(properties?: google.cloud.support.v2.ICase);Constructs a new Case.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICase
Properties to set |
Properties
classification
public classification?: (google.cloud.support.v2.ICaseClassification|null);Case classification.
contactEmail
public contactEmail: string;Case contactEmail.
createTime
public createTime?: (google.protobuf.ITimestamp|null);Case createTime.
creator
public creator?: (google.cloud.support.v2.IActor|null);Case creator.
description
public description: string;Case description.
displayName
public displayName: string;Case displayName.
escalated
public escalated: boolean;Case escalated.
languageCode
public languageCode: string;Case languageCode.
name
public name: string;Case name.
priority
public priority: (google.cloud.support.v2.Case.Priority|keyof typeof google.cloud.support.v2.Case.Priority);Case priority.
state
public state: (google.cloud.support.v2.Case.State|keyof typeof google.cloud.support.v2.Case.State);Case state.
subscriberEmailAddresses
public subscriberEmailAddresses: string[];Case subscriberEmailAddresses.
testCase
public testCase: boolean;Case testCase.
timeZone
public timeZone: string;Case timeZone.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Case updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.support.v2.ICase): google.cloud.support.v2.Case;Creates a new Case instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICase
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Case | Case instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.support.v2.Case;Decodes a Case 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 |
Case | Case |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.support.v2.Case;Decodes a Case message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Case | Case |
encode(message, writer)
public static encode(message: google.cloud.support.v2.ICase, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Case message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICase
Case 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.support.v2.ICase, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Case message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICase
Case 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.support.v2.Case;Creates a Case 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 |
Case | Case |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Case
| 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 Case to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.support.v2.Case, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Case message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Case
Case |
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 Case message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|