Class ListTargetSitesRequest.Builder (0.31.0)

public static final class ListTargetSitesRequest.Builder extends GeneratedMessageV3.Builder<ListTargetSitesRequest.Builder> implements ListTargetSitesRequestOrBuilder

Request message for SiteSearchEngineService.ListTargetSites method.

Protobuf type google.cloud.discoveryengine.v1beta.ListTargetSitesRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListTargetSitesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListTargetSitesRequest.Builder
Overrides

build()

public ListTargetSitesRequest build()
Returns
TypeDescription
ListTargetSitesRequest

buildPartial()

public ListTargetSitesRequest buildPartial()
Returns
TypeDescription
ListTargetSitesRequest

clear()

public ListTargetSitesRequest.Builder clear()
Returns
TypeDescription
ListTargetSitesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListTargetSitesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListTargetSitesRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ListTargetSitesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListTargetSitesRequest.Builder
Overrides

clearPageSize()

public ListTargetSitesRequest.Builder clearPageSize()

Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.

int32 page_size = 2;

Returns
TypeDescription
ListTargetSitesRequest.Builder

This builder for chaining.

clearPageToken()

public ListTargetSitesRequest.Builder clearPageToken()

A page token, received from a previous ListTargetSites call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListTargetSites must match the call that provided the page token.

string page_token = 3;

Returns
TypeDescription
ListTargetSitesRequest.Builder

This builder for chaining.

clearParent()

public ListTargetSitesRequest.Builder clearParent()

Required. The parent site search engine resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

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

Returns
TypeDescription
ListTargetSitesRequest.Builder

This builder for chaining.

clone()

public ListTargetSitesRequest.Builder clone()
Returns
TypeDescription
ListTargetSitesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListTargetSitesRequest getDefaultInstanceForType()
Returns
TypeDescription
ListTargetSitesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getPageSize()

public int getPageSize()

Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.

int32 page_size = 2;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

A page token, received from a previous ListTargetSites call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListTargetSites must match the call that provided the page token.

string page_token = 3;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token, received from a previous ListTargetSites call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListTargetSites must match the call that provided the page token.

string page_token = 3;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent site search engine resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent site search engine resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

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

Returns
TypeDescription
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListTargetSitesRequest other)

public ListTargetSitesRequest.Builder mergeFrom(ListTargetSitesRequest other)
Parameter
NameDescription
otherListTargetSitesRequest
Returns
TypeDescription
ListTargetSitesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListTargetSitesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListTargetSitesRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListTargetSitesRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListTargetSitesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListTargetSitesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListTargetSitesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListTargetSitesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListTargetSitesRequest.Builder
Overrides

setPageSize(int value)

public ListTargetSitesRequest.Builder setPageSize(int value)

Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.

int32 page_size = 2;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListTargetSitesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListTargetSitesRequest.Builder setPageToken(String value)

A page token, received from a previous ListTargetSites call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListTargetSites must match the call that provided the page token.

string page_token = 3;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListTargetSitesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListTargetSitesRequest.Builder setPageTokenBytes(ByteString value)

A page token, received from a previous ListTargetSites call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListTargetSites must match the call that provided the page token.

string page_token = 3;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListTargetSitesRequest.Builder

This builder for chaining.

setParent(String value)

public ListTargetSitesRequest.Builder setParent(String value)

Required. The parent site search engine resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListTargetSitesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListTargetSitesRequest.Builder setParentBytes(ByteString value)

Required. The parent site search engine resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListTargetSitesRequest.Builder

This builder for chaining.

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

public ListTargetSitesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListTargetSitesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListTargetSitesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListTargetSitesRequest.Builder
Overrides