Constructor
new TransferOperation(propertiesopt)
Constructs a new TransferOperation.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.storagetransfer.v1.ITransferOperation |
<optional> |
Properties to set |
- Implements:
-
- ITransferOperation
Members
counters
TransferOperation counters.
endTime
TransferOperation endTime.
errorBreakdowns
TransferOperation errorBreakdowns.
loggingConfig
TransferOperation loggingConfig.
name
TransferOperation name.
notificationConfig
TransferOperation notificationConfig.
projectId
TransferOperation projectId.
startTime
TransferOperation startTime.
status
TransferOperation status.
transferJobName
TransferOperation transferJobName.
transferSpec
TransferOperation transferSpec.
Status
Status enum.
Properties:
| Name | Type | Description |
|---|---|---|
STATUS_UNSPECIFIED |
number |
STATUS_UNSPECIFIED value |
IN_PROGRESS |
number |
IN_PROGRESS value |
PAUSED |
number |
PAUSED value |
SUCCESS |
number |
SUCCESS value |
FAILED |
number |
FAILED value |
ABORTED |
number |
ABORTED value |
QUEUED |
number |
QUEUED value |
SUSPENDING |
number |
SUSPENDING value |
Methods
toJSON() → {Object.<string, *>}
Converts this TransferOperation to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.storagetransfer.v1.TransferOperation}
Creates a new TransferOperation instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.storagetransfer.v1.ITransferOperation |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.storagetransfer.v1.TransferOperation |
TransferOperation instance |
(static) decode(reader, lengthopt) → {google.storagetransfer.v1.TransferOperation}
Decodes a TransferOperation message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.storagetransfer.v1.TransferOperation |
TransferOperation |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.storagetransfer.v1.TransferOperation}
Decodes a TransferOperation message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.storagetransfer.v1.TransferOperation |
TransferOperation |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified TransferOperation message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.storagetransfer.v1.ITransferOperation |
TransferOperation message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified TransferOperation message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.storagetransfer.v1.ITransferOperation |
TransferOperation message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.storagetransfer.v1.TransferOperation}
Creates a TransferOperation message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.storagetransfer.v1.TransferOperation |
TransferOperation |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for TransferOperation
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a TransferOperation message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.storagetransfer.v1.TransferOperation |
TransferOperation |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a TransferOperation message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|