Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::ListTargetSitesRequest (v1.0.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::ListTargetSitesRequest.

Request message for SiteSearchEngineService.ListTargetSites method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#page_size

def page_size() -> ::Integer
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.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::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.

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.

#page_token

def page_token() -> ::String
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.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::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.

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.

#parent

def parent() -> ::String
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 {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite}s under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::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 {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite}s 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 {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite}s under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.