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.
Generated from protobuf field .google.protobuf.Timestamp start_time = 1;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasStartTime
clearStartTime
setStartTime
The create time of an operation.
Generated from protobuf field .google.protobuf.Timestamp start_time = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndTime
The end time of an operation.
Generated from protobuf field .google.protobuf.Timestamp end_time = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasEndTime
clearEndTime
setEndTime
The end time of an operation.
Generated from protobuf field .google.protobuf.Timestamp end_time = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
State of an operation.
Generated from protobuf field .google.logging.v2.OperationState state = 3;
| Returns | |
|---|---|
| Type | Description |
int | |
setState
State of an operation.
Generated from protobuf field .google.logging.v2.OperationState state = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCancellationRequested
Identifies whether the user has requested cancellation of the operation.
Generated from protobuf field bool cancellation_requested = 4;
| Returns | |
|---|---|
| Type | Description |
bool | |
setCancellationRequested
Identifies whether the user has requested cancellation of the operation.
Generated from protobuf field bool cancellation_requested = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRequest
CopyLogEntries RPC request.
Generated from protobuf field .google.logging.v2.CopyLogEntriesRequest request = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Logging\V2\CopyLogEntriesRequest|null | |
hasRequest
clearRequest
setRequest
CopyLogEntries RPC request.
Generated from protobuf field .google.logging.v2.CopyLogEntriesRequest request = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Logging\V2\CopyLogEntriesRequest
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProgress
Estimated progress of the operation (0 - 100%).
Generated from protobuf field int32 progress = 6;
| Returns | |
|---|---|
| Type | Description |
int | |
setProgress
Estimated progress of the operation (0 - 100%).
Generated from protobuf field int32 progress = 6;
| 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"
Generated from protobuf field string writer_identity = 7;
| 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"
Generated from protobuf field string writer_identity = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |