Represents an Operation.
Package
@google-cloud/runConstructors
(constructor)(properties)
constructor
(
properties
?:
google
.
longrunning
.
IOperation
);
Constructs a new Operation.
| Name | Description |
| properties | IOperation
Properties to set |
Properties
done
public
done
:
boolean
;
Operation done.
error
public
error
?:
(
google
.
rpc
.
IStatus
|
null
);
Operation error.
metadata
public
metadata
?:
(
google
.
protobuf
.
IAny
|
null
);
Operation metadata.
name
public
name
:
string
;
Operation name.
response
public
response
?:
(
google
.
protobuf
.
IAny
|
null
);
Operation response.
result
public
result
?:
(
"error"
|
"response"
);
Operation result.
Methods
create(properties)
public
static
create
(
properties
?:
google
.
longrunning
.
IOperation
)
:
google
.
longrunning
.
Operation
;
Creates a new Operation instance using the specified properties.
| Name | Description |
| properties | IOperation
Properties to set |
| Type | Description |
|---|---|
| google.longrunning.Operation | Operation instance |
decode(reader, length)
public
static
decode
(
reader
:
(
$protobuf
.
Reader
|
Uint8Array
),
length
?:
number
)
:
google
.
longrunning
.
Operation
;
Decodes an Operation message from the specified reader or buffer.
| Name | Description |
| reader | ($protobuf. Reader
| Uint8Array
)
Reader or buffer to decode from |
| length | number
Message length if known beforehand |
| Type | Description |
|---|---|
| google.longrunning.Operation | Operation |
decodeDelimited(reader)
public
static
decodeDelimited
(
reader
:
(
$protobuf
.
Reader
|
Uint8Array
))
:
google
.
longrunning
.
Operation
;
Decodes an Operation message from the specified reader or buffer, length delimited.
| Name | Description |
| reader | ($protobuf. Reader
| Uint8Array
)
Reader or buffer to decode from |
| Type | Description |
|---|---|
| google.longrunning.Operation | Operation |
encode(message, writer)
public
static
encode
(
message
:
google
.
longrunning
.
IOperation
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified Operation message. Does not implicitly messages.
| Name | Description |
| message | IOperation
Operation message or plain object to encode |
| writer | $protobuf. Writer
Writer to encode to |
| Type | Description |
|---|---|
| $protobuf. Writer | Writer |
encodeDelimited(message, writer)
public
static
encodeDelimited
(
message
:
google
.
longrunning
.
IOperation
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified Operation message, length delimited. Does not implicitly messages.
| Name | Description |
| message | IOperation
Operation message or plain object to encode |
| writer | $protobuf. Writer
Writer to encode to |
| Type | Description |
|---|---|
| $protobuf. Writer | Writer |
fromObject(object)
public
static
fromObject
(
object
:
{
[
k
:
string
]
:
any
})
:
google
.
longrunning
.
Operation
;
Creates an Operation message from a plain object. Also converts values to their respective internal types.
| Name | Description |
| object | { [k: string]: any }
Plain object |
| Type | Description |
|---|---|
| google.longrunning.Operation | Operation |
getTypeUrl(typeUrlPrefix)
public
static
getTypeUrl
(
typeUrlPrefix
?:
string
)
:
string
;
Gets the default type url for Operation
| Name | Description |
| typeUrlPrefix | string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Type | Description |
|---|---|
| string | The default type url |
toJSON()
public
toJSON
()
:
{
[
k
:
string
]
:
any
};
Converts this Operation to JSON.
| Type | Description |
|---|---|
| { [k: string]: any } | JSON object |
toObject(message, options)
public
static
toObject
(
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.
| Name | Description |
| message | google.longrunning.Operation
Operation |
| options | $protobuf. IConversionOptions
Conversion options |
| Type | Description |
|---|---|
| { [k: string]: any } | Plain object |
verify(message)
public
static
verify
(
message
:
{
[
k
:
string
]
:
any
})
:
(
string
|
null
);
Verifies an Operation message.
| Name | Description |
| message | { [k: string]: any }
Plain object to verify |
| Type | Description |
| (string|null) | |
