Class protos.google.api.HttpBody (5.5.2)
Represents a HttpBody.
Package
@google-cloud/tasksConstructors
(constructor)(properties)
constructor(properties?:google.api.IHttpBody);Constructs a new HttpBody.
| Parameter | |
|---|---|
| Name | Description |
properties | IHttpBodyProperties to set |
Properties
contentType
publiccontentType:string;HttpBody contentType.
data
publicdata:(Uint8Array|string);HttpBody data.
extensions
publicextensions:google.protobuf.IAny[];HttpBody extensions.
Methods
create(properties)
publicstaticcreate(properties?:google.api.IHttpBody):google.api.HttpBody;Creates a new HttpBody instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | IHttpBodyProperties to set |
| Returns | |
|---|---|
| Type | Description |
HttpBody | HttpBody instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.api.HttpBody;Decodes a HttpBody message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
length | numberMessage length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
HttpBody | HttpBody |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.api.HttpBody;Decodes a HttpBody message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
HttpBody | HttpBody |
encode(message, writer)
publicstaticencode(message:google.api.IHttpBody,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified HttpBody message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IHttpBodyHttpBody message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
publicstaticencodeDelimited(message:google.api.IHttpBody,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified HttpBody message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IHttpBodyHttpBody message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
publicstaticfromObject(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 |
HttpBody | HttpBody |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for HttpBody
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix | stringyour custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
publictoJSON():{[k:string]:any};Converts this HttpBody to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
publicstatictoObject(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 | HttpBodyHttpBody |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(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) |
|
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.