Class protos.google.cloud.apigeeconnect.v1.HttpResponse (2.1.3)

Version 2.1.3

• 3.0.2 (latest)
• 2.2.2
• 2.1.3
• 1.1.1
• 1.0.5

Represents a HttpResponse.

Package

@google-cloud/apigee-connect

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.apigeeconnect.v1.IHttpResponse);

Constructs a new HttpResponse.

Parameter

Name	Description
properties	IHttpResponse Properties to set

Properties

body

public body: (Uint8Array|string);

HttpResponse body.

contentLength

public contentLength: (number|Long|string);

HttpResponse contentLength.

headers

public headers: google.cloud.apigeeconnect.v1.IHeader[];

HttpResponse headers.

id

public id: string;

HttpResponse id.

status

public status: string;

HttpResponse status.

statusCode

public statusCode: number;

HttpResponse statusCode.

Methods

create(properties)

public static create(properties?: google.cloud.apigeeconnect.v1.IHttpResponse): google.cloud.apigeeconnect.v1.HttpResponse;

Creates a new HttpResponse instance using the specified properties.

Parameter

Name	Description
properties	IHttpResponse Properties to set

Returns

Type	Description
google.cloud.apigeeconnect.v1.HttpResponse	HttpResponse instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.apigeeconnect.v1.HttpResponse;

Decodes a HttpResponse 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.cloud.apigeeconnect.v1.HttpResponse	HttpResponse

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.apigeeconnect.v1.HttpResponse;

Decodes a HttpResponse 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.cloud.apigeeconnect.v1.HttpResponse	HttpResponse

encode(message, writer)

public static encode(message: google.cloud.apigeeconnect.v1.IHttpResponse, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified HttpResponse message. Does not implicitly messages.

Parameters

Name	Description
message	IHttpResponse HttpResponse 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.apigeeconnect.v1.IHttpResponse, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	IHttpResponse HttpResponse 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.apigeeconnect.v1.HttpResponse;

Creates a HttpResponse 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.cloud.apigeeconnect.v1.HttpResponse	HttpResponse

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for HttpResponse

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

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	google.cloud.apigeeconnect.v1.HttpResponse HttpResponse
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 HttpResponse 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