Class protos.google.longrunning.Operation (4.5.0)
Represents an Operation.
Package
@google-cloud/kmsConstructors
(constructor)(properties)
constructor(properties?:google.longrunning.IOperation);Constructs a new Operation.
| Parameter | |
|---|---|
| Name | Description |
properties | IOperationProperties to set |
Properties
done
publicdone:boolean;Operation done.
error
publicerror?:(google.rpc.IStatus|null);Operation error.
metadata
publicmetadata?:(google.protobuf.IAny|null);Operation metadata.
name
publicname:string;Operation name.
response
publicresponse?:(google.protobuf.IAny|null);Operation response.
result
publicresult?:("error"|"response");Operation result.
Methods
create(properties)
publicstaticcreate(properties?:google.longrunning.IOperation):google.longrunning.Operation;Creates a new Operation instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | IOperationProperties to set |
| Returns | |
|---|---|
| Type | Description |
Operation | Operation instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.longrunning.Operation;Decodes an Operation 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 |
Operation | Operation |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.longrunning.Operation;Decodes an Operation message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Operation | Operation |
encode(message, writer)
publicstaticencode(message:google.longrunning.IOperation,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified Operation message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IOperationOperation message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
publicstaticencodeDelimited(message:google.longrunning.IOperation,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified Operation message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IOperationOperation 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.longrunning.Operation;Creates an Operation 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 |
Operation | Operation |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for Operation
| 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 Operation to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
publicstatictoObject(message:google.longrunning.Operation,options?:$protobuf.IConversionOptions):{[k:string]:any};Creates a plain object from an Operation message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message | OperationOperation |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(message:{[k:string]:any}):(string|null);Verifies an Operation 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.