Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class PurgeDocumentsMetadata.
Metadata related to the progress of the PurgeDocuments operation.
This will be returned by the google.longrunning.Operation.metadata field.
Generated from protobuf message google.cloud.discoveryengine.v1.PurgeDocumentsMetadata
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ create_time |
Google\Protobuf\Timestamp
Operation create time. |
↳ update_time |
Google\Protobuf\Timestamp
Operation last update time. If the operation is done, this is also the finish time. |
↳ success_count |
int|string
Count of entries that were deleted successfully. |
↳ failure_count |
int|string
Count of entries that encountered errors while processing. |
↳ ignored_count |
int|string
Count of entries that were ignored as entries were not found. |
getCreateTime
Operation create time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Operation create time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Operation last update time. If the operation is done, this is also the finish time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Operation last update time. If the operation is done, this is also the finish time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSuccessCount
Count of entries that were deleted successfully.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setSuccessCount
Count of entries that were deleted successfully.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFailureCount
Count of entries that encountered errors while processing.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setFailureCount
Count of entries that encountered errors while processing.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIgnoredCount
Count of entries that were ignored as entries were not found.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setIgnoredCount
Count of entries that were ignored as entries were not found.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|