Google Cloud Discovery Engine V1 Client - Class RecrawlUrisMetadata (1.2.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class RecrawlUrisMetadata.

Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.

Generated from protobuf message google.cloud.discoveryengine.v1.RecrawlUrisMetadata

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__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.

↳ invalid_uris array

Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.

↳ valid_uris_count int

Total number of unique URIs in the request that are not in invalid_uris.

↳ success_count int

Total number of URIs that have been crawled so far.

↳ pending_count int

Total number of URIs that have yet to be crawled.

↳ quota_exceeded_count int

Total number of URIs that were rejected due to insufficient indexing resources.

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

getInvalidUris

Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setInvalidUris

Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getValidUrisCount

Total number of unique URIs in the request that are not in invalid_uris.

Returns
Type Description
int

setValidUrisCount

Total number of unique URIs in the request that are not in invalid_uris.

Parameter
Name Description
var int
Returns
Type Description
$this

getSuccessCount

Total number of URIs that have been crawled so far.

Returns
Type Description
int

setSuccessCount

Total number of URIs that have been crawled so far.

Parameter
Name Description
var int
Returns
Type Description
$this

getPendingCount

Total number of URIs that have yet to be crawled.

Returns
Type Description
int

setPendingCount

Total number of URIs that have yet to be crawled.

Parameter
Name Description
var int
Returns
Type Description
$this

getQuotaExceededCount

Total number of URIs that were rejected due to insufficient indexing resources.

Returns
Type Description
int

setQuotaExceededCount

Total number of URIs that were rejected due to insufficient indexing resources.

Parameter
Name Description
var int
Returns
Type Description
$this