public final class ListTargetSitesRequest extends GeneratedMessageV3 implements ListTargetSitesRequestOrBuilder
Request message for
SiteSearchEngineService.ListTargetSites
method.
Protobuf type google.cloud.discoveryengine.v1.ListTargetSitesRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ListTargetSitesRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListTargetSitesRequest.Builder newBuilder()
newBuilder(ListTargetSitesRequest prototype)
public static ListTargetSitesRequest.Builder newBuilder(ListTargetSitesRequest prototype)
public static ListTargetSitesRequest parseDelimitedFrom(InputStream input)
public static ListTargetSitesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListTargetSitesRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListTargetSitesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListTargetSitesRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListTargetSitesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListTargetSitesRequest parseFrom(CodedInputStream input)
public static ListTargetSitesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListTargetSitesRequest parseFrom(InputStream input)
public static ListTargetSitesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListTargetSitesRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListTargetSitesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListTargetSitesRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ListTargetSitesRequest getDefaultInstanceForType()
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.
|
getParserForType()
public Parser<ListTargetSitesRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ListTargetSitesRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListTargetSitesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ListTargetSitesRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
