Class protos.google.api.servicecontrol.v1.CheckError (3.2.0)

Represents a CheckError.

Package

@google-cloud/service-control

Constructors

(constructor)(properties)

constructor(properties?: google.api.servicecontrol.v1.ICheckError);

Constructs a new CheckError.

Parameter
NameDescription
properties ICheckError

Properties to set

Properties

code

public code: (google.api.servicecontrol.v1.CheckError.Code|keyof typeof google.api.servicecontrol.v1.CheckError.Code);

CheckError code.

detail

public detail: string;

CheckError detail.

status

public status?: (google.rpc.IStatus|null);

CheckError status.

subject

public subject: string;

CheckError subject.

Methods

create(properties)

public static create(properties?: google.api.servicecontrol.v1.ICheckError): google.api.servicecontrol.v1.CheckError;

Creates a new CheckError instance using the specified properties.

Parameter
NameDescription
properties ICheckError

Properties to set

Returns
TypeDescription
CheckError

CheckError instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.api.servicecontrol.v1.CheckError;

Decodes a CheckError 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
CheckError

CheckError

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.api.servicecontrol.v1.CheckError;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
CheckError

CheckError

encode(message, writer)

public static encode(message: google.api.servicecontrol.v1.ICheckError, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CheckError message. Does not implicitly messages.

Parameters
NameDescription
message ICheckError

CheckError 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.api.servicecontrol.v1.ICheckError, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ICheckError

CheckError 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.api.servicecontrol.v1.CheckError;

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

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

Plain object

Returns
TypeDescription
CheckError

CheckError

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CheckError

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 CheckError to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message CheckError

CheckError

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a CheckError 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