Class RecrawlUrisRequest (0.51.0)

public final class RecrawlUrisRequest extends GeneratedMessageV3 implements RecrawlUrisRequestOrBuilder

Request message for SiteSearchEngineService.RecrawlUris method.

Protobuf type google.cloud.discoveryengine.v1beta.RecrawlUrisRequest

Static Fields

SITE_CREDENTIAL_FIELD_NUMBER

public static final int SITE_CREDENTIAL_FIELD_NUMBER
Field Value
Type Description
int

SITE_SEARCH_ENGINE_FIELD_NUMBER

public static final int SITE_SEARCH_ENGINE_FIELD_NUMBER
Field Value
Type Description
int

URIS_FIELD_NUMBER

public static final int URIS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RecrawlUrisRequest getDefaultInstance()
Returns
Type Description
RecrawlUrisRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RecrawlUrisRequest.Builder newBuilder()
Returns
Type Description
RecrawlUrisRequest.Builder

newBuilder(RecrawlUrisRequest prototype)

public static RecrawlUrisRequest.Builder newBuilder(RecrawlUrisRequest prototype)
Parameter
Name Description
prototype RecrawlUrisRequest
Returns
Type Description
RecrawlUrisRequest.Builder

parseDelimitedFrom(InputStream input)

public static RecrawlUrisRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RecrawlUrisRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RecrawlUrisRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RecrawlUrisRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RecrawlUrisRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RecrawlUrisRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RecrawlUrisRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RecrawlUrisRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RecrawlUrisRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RecrawlUrisRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RecrawlUrisRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RecrawlUrisRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RecrawlUrisRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RecrawlUrisRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RecrawlUrisRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RecrawlUrisRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RecrawlUrisRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RecrawlUrisRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RecrawlUrisRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RecrawlUrisRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RecrawlUrisRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RecrawlUrisRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RecrawlUrisRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RecrawlUrisRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RecrawlUrisRequest> parser()
Returns
Type Description
Parser<RecrawlUrisRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public RecrawlUrisRequest getDefaultInstanceForType()
Returns
Type Description
RecrawlUrisRequest

getParserForType()

public Parser<RecrawlUrisRequest> getParserForType()
Returns
Type Description
Parser<RecrawlUrisRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSiteCredential()

public String getSiteCredential()

Optional. Full resource name of the [SiteCredential][], such as projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*. Only set to crawl private URIs.

string site_credential = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The siteCredential.

getSiteCredentialBytes()

public ByteString getSiteCredentialBytes()

Optional. Full resource name of the [SiteCredential][], such as projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*. Only set to crawl private URIs.

string site_credential = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for siteCredential.

getSiteSearchEngine()

public String getSiteSearchEngine()

Required. Full resource name of the SiteSearchEngine, such as projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

string site_search_engine = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The siteSearchEngine.

getSiteSearchEngineBytes()

public ByteString getSiteSearchEngineBytes()

Required. Full resource name of the SiteSearchEngine, such as projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

string site_search_engine = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for siteSearchEngine.

getUris(int index)

public String getUris(int index)

Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in site_search_engine.

repeated string uris = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The uris at the given index.

getUrisBytes(int index)

public ByteString getUrisBytes(int index)

Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in site_search_engine.

repeated string uris = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the uris at the given index.

getUrisCount()

public int getUrisCount()

Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in site_search_engine.

repeated string uris = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of uris.

getUrisList()

public ProtocolStringList getUrisList()

Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in site_search_engine.

repeated string uris = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProtocolStringList

A list containing the uris.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RecrawlUrisRequest.Builder newBuilderForType()
Returns
Type Description
RecrawlUrisRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RecrawlUrisRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RecrawlUrisRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RecrawlUrisRequest.Builder toBuilder()
Returns
Type Description
RecrawlUrisRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException