Class: Google::Cloud::DiscoveryEngine::V1::ListTargetSitesRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/site_search_engine_service.rb

Overview

Request message for SiteSearchEngineService.ListTargetSites method.

Instance Attribute Summary collapse

Instance Attribute Details

#page_size ⇒ ::Integer

Returns 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.

Returns:

  • (::Integer) —

    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.



208
209
210
211
 
# File 'proto_docs/google/cloud/discoveryengine/v1/site_search_engine_service.rb', line 208

class ListTargetSitesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



208
209
210
211
 
# File 'proto_docs/google/cloud/discoveryengine/v1/site_search_engine_service.rb', line 208

class ListTargetSitesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



208
209
210
211
 
# File 'proto_docs/google/cloud/discoveryengine/v1/site_search_engine_service.rb', line 208

class ListTargetSitesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end