Reference documentation and code samples for the Stackdriver Logging V2 Client class CopyLogEntriesMetadata.
Metadata for CopyLogEntries long running operations.
Generated from protobuf message google.logging.v2.CopyLogEntriesMetadata
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ start_time |
Google\Protobuf\Timestamp
The create time of an operation. |
↳ end_time |
Google\Protobuf\Timestamp
The end time of an operation. |
↳ state |
int
State of an operation. |
↳ cancellation_requested |
bool
Identifies whether the user has requested cancellation of the operation. |
↳ request |
Google\Cloud\Logging\V2\CopyLogEntriesRequest
CopyLogEntries RPC request. |
↳ progress |
int
Estimated progress of the operation (0 - 100%). |
↳ writer_identity |
string
The IAM identity of a service account that must be granted access to the destination. If the service account is not granted permission to the destination within an hour, the operation will be cancelled. For example: |
getStartTime
The create time of an operation.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasStartTime
clearStartTime
setStartTime
The create time of an operation.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndTime
The end time of an operation.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasEndTime
clearEndTime
setEndTime
The end time of an operation.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
State of an operation.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
State of an operation.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCancellationRequested
Identifies whether the user has requested cancellation of the operation.
| Returns | |
|---|---|
| Type | Description |
bool | |
setCancellationRequested
Identifies whether the user has requested cancellation of the operation.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRequest
CopyLogEntries RPC request.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Logging\V2\CopyLogEntriesRequest|null | |
hasRequest
clearRequest
setRequest
CopyLogEntries RPC request.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Logging\V2\CopyLogEntriesRequest
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProgress
Estimated progress of the operation (0 - 100%).
| Returns | |
|---|---|
| Type | Description |
int | |
setProgress
Estimated progress of the operation (0 - 100%).
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getWriterIdentity
The IAM identity of a service account that must be granted access to the destination.
If the service account is not granted permission to the destination within
an hour, the operation will be cancelled.
For example: "serviceAccount:foo@bar.com"
| Returns | |
|---|---|
| Type | Description |
string | |
setWriterIdentity
The IAM identity of a service account that must be granted access to the destination.
If the service account is not granted permission to the destination within
an hour, the operation will be cancelled.
For example: "serviceAccount:foo@bar.com"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |