Package com.google.cloud.discoveryengine.v1beta

Class ListTargetSitesRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListTargetSitesRequest.Builder>
com.google.cloud.discoveryengine.v1beta.ListTargetSitesRequest.Builder
All Implemented Interfaces:
ListTargetSitesRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListTargetSitesRequest
public static final class ListTargetSitesRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListTargetSitesRequest.Builder> implements ListTargetSitesRequestOrBuilder
 Request message for
 [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.ListTargetSites]
 method.
Protobuf type google.cloud.discoveryengine.v1beta.ListTargetSitesRequest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListTargetSitesRequest.Builder>

    • clear

      public ListTargetSitesRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ListTargetSitesRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListTargetSitesRequest.Builder>

    • getDefaultInstanceForType

      public ListTargetSitesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public ListTargetSitesRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public ListTargetSitesRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public ListTargetSitesRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListTargetSitesRequest.Builder>

    • mergeFrom

      public ListTargetSitesRequest.Builder mergeFrom(ListTargetSitesRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListTargetSitesRequest.Builder>

    • mergeFrom

      public ListTargetSitesRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListTargetSitesRequest.Builder>
      Throws:
      IOException

    • 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
 [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) = { ... }
      Specified by:
      getParent in interface ListTargetSitesRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public 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) = { ... }
      Specified by:
      getParentBytes in interface ListTargetSitesRequestOrBuilder
      Returns:
      The bytes for parent.

    • setParent

      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
 [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) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      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
 [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:
      This builder for chaining.

    • setParentBytes

      public ListTargetSitesRequest.Builder setParentBytes(com.google.protobuf.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
 [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) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • 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;
      Specified by:
      getPageSize in interface ListTargetSitesRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      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;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

    • 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;
      Specified by:
      getPageToken in interface ListTargetSitesRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public 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;
      Specified by:
      getPageTokenBytes in interface ListTargetSitesRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      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;
      Parameters:
      value - The pageToken to set.
      Returns:
      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:
      This builder for chaining.

    • setPageTokenBytes

      public ListTargetSitesRequest.Builder setPageTokenBytes(com.google.protobuf.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;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.