Class RecrawlUrisRequest.Builder (0.51.0)

public static final class RecrawlUrisRequest.Builder extends GeneratedMessageV3.Builder<RecrawlUrisRequest.Builder> implements RecrawlUrisRequestOrBuilder

Request message for SiteSearchEngineService.RecrawlUris method.

Protobuf type google.cloud.discoveryengine.v1.RecrawlUrisRequest

Static Methods

getDescriptor()

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

Methods

addAllUris(Iterable<String> values)

public RecrawlUrisRequest.Builder addAllUris(Iterable<String> values)

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
values Iterable<String>

The uris to add.

Returns
Type Description
RecrawlUrisRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RecrawlUrisRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RecrawlUrisRequest.Builder
Overrides

addUris(String value)

public RecrawlUrisRequest.Builder addUris(String value)

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
value String

The uris to add.

Returns
Type Description
RecrawlUrisRequest.Builder

This builder for chaining.

addUrisBytes(ByteString value)

public RecrawlUrisRequest.Builder addUrisBytes(ByteString value)

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
value ByteString

The bytes of the uris to add.

Returns
Type Description
RecrawlUrisRequest.Builder

This builder for chaining.

build()

public RecrawlUrisRequest build()
Returns
Type Description
RecrawlUrisRequest

buildPartial()

public RecrawlUrisRequest buildPartial()
Returns
Type Description
RecrawlUrisRequest

clear()

public RecrawlUrisRequest.Builder clear()
Returns
Type Description
RecrawlUrisRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public RecrawlUrisRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RecrawlUrisRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public RecrawlUrisRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RecrawlUrisRequest.Builder
Overrides

clearSiteCredential()

public RecrawlUrisRequest.Builder clearSiteCredential()

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
RecrawlUrisRequest.Builder

This builder for chaining.

clearSiteSearchEngine()

public RecrawlUrisRequest.Builder clearSiteSearchEngine()

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
RecrawlUrisRequest.Builder

This builder for chaining.

clearUris()

public RecrawlUrisRequest.Builder clearUris()

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
RecrawlUrisRequest.Builder

This builder for chaining.

clone()

public RecrawlUrisRequest.Builder clone()
Returns
Type Description
RecrawlUrisRequest.Builder
Overrides

getDefaultInstanceForType()

public RecrawlUrisRequest getDefaultInstanceForType()
Returns
Type Description
RecrawlUrisRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RecrawlUrisRequest other)

public RecrawlUrisRequest.Builder mergeFrom(RecrawlUrisRequest other)
Parameter
Name Description
other RecrawlUrisRequest
Returns
Type Description
RecrawlUrisRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RecrawlUrisRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RecrawlUrisRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RecrawlUrisRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RecrawlUrisRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RecrawlUrisRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RecrawlUrisRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public RecrawlUrisRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RecrawlUrisRequest.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RecrawlUrisRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RecrawlUrisRequest.Builder
Overrides

setSiteCredential(String value)

public RecrawlUrisRequest.Builder setSiteCredential(String value)

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];

Parameter
Name Description
value String

The siteCredential to set.

Returns
Type Description
RecrawlUrisRequest.Builder

This builder for chaining.

setSiteCredentialBytes(ByteString value)

public RecrawlUrisRequest.Builder setSiteCredentialBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for siteCredential to set.

Returns
Type Description
RecrawlUrisRequest.Builder

This builder for chaining.

setSiteSearchEngine(String value)

public RecrawlUrisRequest.Builder setSiteSearchEngine(String value)

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) = { ... }

Parameter
Name Description
value String

The siteSearchEngine to set.

Returns
Type Description
RecrawlUrisRequest.Builder

This builder for chaining.

setSiteSearchEngineBytes(ByteString value)

public RecrawlUrisRequest.Builder setSiteSearchEngineBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for siteSearchEngine to set.

Returns
Type Description
RecrawlUrisRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RecrawlUrisRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RecrawlUrisRequest.Builder
Overrides

setUris(int index, String value)

public RecrawlUrisRequest.Builder setUris(int index, String value)

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];

Parameters
Name Description
index int

The index to set the value at.

value String

The uris to set.

Returns
Type Description
RecrawlUrisRequest.Builder

This builder for chaining.