Represents an Envelope.
Package
@google-cloud/binary-authorizationConstructors
(constructor)(properties)
constructor(properties?: grafeas.v1.IEnvelope);Constructs a new Envelope.
| Parameter | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Name | Description |
properties |
IEnvelope
Properties to set |
| Returns | |
|---|---|
| Type | Description |
grafeas.v1.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 | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
grafeas.v1.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 | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
grafeas.v1.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 | |
|---|---|
| Name | Description |
message |
IEnvelope
Envelope 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: grafeas.v1.IEnvelope, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Envelope message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IEnvelope
Envelope 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 }): grafeas.v1.Envelope;Creates an Envelope 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 |
grafeas.v1.Envelope | Envelope |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Envelope
| 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 Envelope to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [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 | |
|---|---|
| Name | Description |
message |
grafeas.v1.Envelope
Envelope |
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 an Envelope message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|