Discovery Engine v1 API - Class ListTargetSitesRequest (1.3.0)

public sealed class ListTargetSitesRequest : IMessage<ListTargetSitesRequest>, IEquatable<ListTargetSitesRequest>, IDeepCloneable<ListTargetSitesRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Discovery Engine v1 API class ListTargetSitesRequest.

Request message for [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.ListTargetSites] method.

Inheritance

object > ListTargetSitesRequest

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

ListTargetSitesRequest()

public ListTargetSitesRequest()

ListTargetSitesRequest(ListTargetSitesRequest)

public ListTargetSitesRequest(ListTargetSitesRequest other)
Parameter
Name Description
other ListTargetSitesRequest

Properties

PageSize

public int PageSize { get; set; }

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.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

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.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

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.v1.TargetSite]s under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

Property Value
Type Description
string

ParentAsSiteSearchEngineName

public SiteSearchEngineName ParentAsSiteSearchEngineName { get; set; }

SiteSearchEngineName-typed view over the Parent resource name property.

Property Value
Type Description
SiteSearchEngineName