Class protos.google.api.HttpBody (3.1.2)

Version 3.1.2

• 4.1.1 (latest)
• 4.0.0
• 3.6.0
• 3.3.0
• 3.2.0
• 3.1.2
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.2
• 2.2.7

Represents a HttpBody.

Package

@google-cloud/cloudbuild

Constructors

(constructor)(properties)

constructor(properties?: google.api.IHttpBody);

Constructs a new HttpBody.

Parameter

Name	Description
properties	IHttpBody Properties to set

Properties

contentType

public contentType: string;

HttpBody contentType.

data

public data: (Uint8Array|string);

HttpBody data.

extensions

public extensions: google.protobuf.IAny[];

HttpBody extensions.

Methods

create(properties)

public static create(properties?: google.api.IHttpBody): google.api.HttpBody;

Creates a new HttpBody instance using the specified properties.

Parameter

Name	Description
properties	IHttpBody Properties to set

Returns

Type	Description
google.api.HttpBody	HttpBody instance

decode(reader, length)

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

Decodes a HttpBody 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
google.api.HttpBody	HttpBody

decodeDelimited(reader)

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

Decodes a HttpBody 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
google.api.HttpBody	HttpBody

encode(message, writer)

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

Encodes the specified HttpBody message. Does not implicitly messages.

Parameters

Name	Description
message	IHttpBody HttpBody 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.api.IHttpBody, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	IHttpBody HttpBody 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.api.HttpBody;

Creates a HttpBody 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
google.api.HttpBody	HttpBody

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for HttpBody

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

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	google.api.HttpBody HttpBody
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 HttpBody message.

Parameter

Name	Description
message	{ [k: string]: any } Plain object to verify

Returns

Type	Description
(string|null)	null if valid, otherwise the reason why it is not