Package com.google.cloud.discoveryengine.v1beta

Interface ListTargetSitesRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListTargetSitesRequest, ListTargetSitesRequest.Builder
@Generated public interface ListTargetSitesRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getPageSize()
    Requested page size.
    String
    getPageToken()
    A page token, received from a previous `ListTargetSites` call.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    A page token, received from a previous `ListTargetSites` call.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getParent

      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
 [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s 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:
      The parent.

    • getParentBytes

      com.google.protobuf.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
 [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s 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:
      The bytes for parent.

    • getPageSize

      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:
      The pageSize.

    • getPageToken

      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:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.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:
      The bytes for pageToken.