Class protos.grafeas.v1.Envelope (5.0.1)

Represents an Envelope.

Package

@google-cloud/containeranalysis

Constructors

(constructor)(properties)

constructor(properties?: grafeas.v1.IEnvelope);

Constructs a new Envelope.

Parameter
NameDescription
properties IEnvelope

Properties to set

Properties

payload

public payload: (Uint8Array|string);

Envelope payload.

payloadType

public payloadType: string;

Envelope payloadType.

signatures

public signatures: grafeas.v1.IEnvelopeSignature[];

Envelope signatures.

Methods

create(properties)

public static create(properties?: grafeas.v1.IEnvelope): grafeas.v1.Envelope;

Creates a new Envelope instance using the specified properties.

Parameter
NameDescription
properties IEnvelope

Properties to set

Returns
TypeDescription
Envelope

Envelope instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): grafeas.v1.Envelope;

Decodes an Envelope 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
Envelope

Envelope

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): grafeas.v1.Envelope;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Envelope

Envelope

encode(message, writer)

public static encode(message: grafeas.v1.IEnvelope, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Envelope message. Does not implicitly messages.

Parameters
NameDescription
message IEnvelope

Envelope 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: grafeas.v1.IEnvelope, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IEnvelope

Envelope 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 }): grafeas.v1.Envelope;

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

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

Plain object

Returns
TypeDescription
Envelope

Envelope

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Envelope

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: grafeas.v1.Envelope, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message Envelope

Envelope

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 Envelope 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