Class RecrawlUrisMetadata (0.37.0)

public final class RecrawlUrisMetadata extends GeneratedMessageV3 implements RecrawlUrisMetadataOrBuilder

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

Protobuf type google.cloud.discoveryengine.v1alpha.RecrawlUrisMetadata

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

INVALID_URIS_FIELD_NUMBER

public static final int INVALID_URIS_FIELD_NUMBER
Field Value
TypeDescription
int

PENDING_COUNT_FIELD_NUMBER

public static final int PENDING_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

QUOTA_EXCEEDED_COUNT_FIELD_NUMBER

public static final int QUOTA_EXCEEDED_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

SUCCESS_COUNT_FIELD_NUMBER

public static final int SUCCESS_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

VALID_URIS_COUNT_FIELD_NUMBER

public static final int VALID_URIS_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RecrawlUrisMetadata getDefaultInstance()
Returns
TypeDescription
RecrawlUrisMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static RecrawlUrisMetadata.Builder newBuilder()
Returns
TypeDescription
RecrawlUrisMetadata.Builder

newBuilder(RecrawlUrisMetadata prototype)

public static RecrawlUrisMetadata.Builder newBuilder(RecrawlUrisMetadata prototype)
Parameter
NameDescription
prototypeRecrawlUrisMetadata
Returns
TypeDescription
RecrawlUrisMetadata.Builder

parseDelimitedFrom(InputStream input)

public static RecrawlUrisMetadata parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RecrawlUrisMetadata
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RecrawlUrisMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecrawlUrisMetadata
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RecrawlUrisMetadata parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RecrawlUrisMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RecrawlUrisMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecrawlUrisMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RecrawlUrisMetadata parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RecrawlUrisMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RecrawlUrisMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecrawlUrisMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RecrawlUrisMetadata parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RecrawlUrisMetadata
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RecrawlUrisMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecrawlUrisMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RecrawlUrisMetadata parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RecrawlUrisMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RecrawlUrisMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecrawlUrisMetadata
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RecrawlUrisMetadata parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RecrawlUrisMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RecrawlUrisMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecrawlUrisMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RecrawlUrisMetadata> parser()
Returns
TypeDescription
Parser<RecrawlUrisMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public RecrawlUrisMetadata getDefaultInstanceForType()
Returns
TypeDescription
RecrawlUrisMetadata

getInvalidUris(int index)

public String getInvalidUris(int index)

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.

repeated string invalid_uris = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The invalidUris at the given index.

getInvalidUrisBytes(int index)

public ByteString getInvalidUrisBytes(int index)

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.

repeated string invalid_uris = 3;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the invalidUris at the given index.

getInvalidUrisCount()

public int getInvalidUrisCount()

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.

repeated string invalid_uris = 3;

Returns
TypeDescription
int

The count of invalidUris.

getInvalidUrisList()

public ProtocolStringList getInvalidUrisList()

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.

repeated string invalid_uris = 3;

Returns
TypeDescription
ProtocolStringList

A list containing the invalidUris.

getParserForType()

public Parser<RecrawlUrisMetadata> getParserForType()
Returns
TypeDescription
Parser<RecrawlUrisMetadata>
Overrides

getPendingCount()

public int getPendingCount()

Total number of URIs that have yet to be crawled.

int32 pending_count = 6;

Returns
TypeDescription
int

The pendingCount.

getQuotaExceededCount()

public int getQuotaExceededCount()

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

int32 quota_exceeded_count = 7;

Returns
TypeDescription
int

The quotaExceededCount.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSuccessCount()

public int getSuccessCount()

Total number of URIs that have been crawled so far.

int32 success_count = 5;

Returns
TypeDescription
int

The successCount.

getUpdateTime()

public Timestamp getUpdateTime()

Operation last update time. If the operation is done, this is also the finish time.

.google.protobuf.Timestamp update_time = 2;

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Operation last update time. If the operation is done, this is also the finish time.

.google.protobuf.Timestamp update_time = 2;

Returns
TypeDescription
TimestampOrBuilder

getValidUrisCount()

public int getValidUrisCount()

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

int32 valid_uris_count = 4;

Returns
TypeDescription
int

The validUrisCount.

hasCreateTime()

public boolean hasCreateTime()

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Operation last update time. If the operation is done, this is also the finish time.

.google.protobuf.Timestamp update_time = 2;

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public RecrawlUrisMetadata.Builder newBuilderForType()
Returns
TypeDescription
RecrawlUrisMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RecrawlUrisMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RecrawlUrisMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public RecrawlUrisMetadata.Builder toBuilder()
Returns
TypeDescription
RecrawlUrisMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException