public static final class ListTargetSitesRequest.Builder extends GeneratedMessageV3.Builder<ListTargetSitesRequest.Builder> implements ListTargetSitesRequestOrBuilderRequest message for SiteSearchEngineService.ListTargetSites method.
Protobuf type google.cloud.discoveryengine.v1beta.ListTargetSitesRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListTargetSitesRequest.BuilderImplements
ListTargetSitesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListTargetSitesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListTargetSitesRequest.Builder |
|
build()
public ListTargetSitesRequest build()| Returns | |
|---|---|
| Type | Description |
ListTargetSitesRequest |
|
buildPartial()
public ListTargetSitesRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListTargetSitesRequest |
|
clear()
public ListTargetSitesRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListTargetSitesRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ListTargetSitesRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListTargetSitesRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public ListTargetSitesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListTargetSitesRequest.Builder |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ListTargetSitesRequest.Builder |
This builder for chaining. |
clone()
public ListTargetSitesRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListTargetSitesRequest.Builder |
|
getDefaultInstanceForType()
public ListTargetSitesRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListTargetSitesRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ListTargetSitesRequest other)
public ListTargetSitesRequest.Builder mergeFrom(ListTargetSitesRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListTargetSitesRequest |
| Returns | |
|---|---|
| Type | Description |
ListTargetSitesRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListTargetSitesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListTargetSitesRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListTargetSitesRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListTargetSitesRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListTargetSitesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListTargetSitesRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ListTargetSitesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListTargetSitesRequest.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListTargetSitesRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ListTargetSitesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListTargetSitesRequest.Builder |
|