Class IndexingResource.DatasourcesResource.ItemsResource.ListRequest

Lists all or a subset of Item resources. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListItemsResponse>
CloudSearchBaseServiceRequest<ListItemsResponse>
IndexingResource.DatasourcesResource.ItemsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.CloudSearch.v1
Assembly: Google.Apis.CloudSearch.v1.dll
Syntax
public class IndexingResource.DatasourcesResource.ItemsResource.ListRequest : CloudSearchBaseServiceRequest<ListItemsResponse>, IClientServiceRequest<ListItemsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string name)
Parameters
Type Name Description
IClientService service
string name

Properties

Brief

When set to true, the indexing system only populates the following fields: name, version, queue. metadata.hash, metadata.title, metadata.sourceRepositoryURL, metadata.objectType, metadata.createTime, metadata.updateTime, metadata.contentLanguage, metadata.mimeType, structured_data.hash, content.hash, itemType, itemStatus.code, itemStatus.processingError.code, itemStatus.repositoryError.type, If this value is false, then all the fields are populated in Item.

Declaration
[RequestParameter("brief", RequestParameterType.Query)]
public virtual bool? Brief { get; set; }
Property Value
Type Description
bool?

ConnectorName

The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}

Declaration
[RequestParameter("connectorName", RequestParameterType.Query)]
public virtual string ConnectorName { get; set; }
Property Value
Type Description
string

DebugOptionsEnableDebugging

If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

Declaration
[RequestParameter("debugOptions.enableDebugging", RequestParameterType.Query)]
public virtual bool? DebugOptionsEnableDebugging { get; set; }
Property Value
Type Description
bool?

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Name

The name of the Data Source to list Items. Format: datasources/{source_id}

Declaration
[RequestParameter("name", RequestParameterType.Path)]
public virtual string Name { get; }
Property Value
Type Description
string

PageSize

Maximum number of items to fetch in a request. The max value is 1000 when brief is true. The max value is 10 if brief is false. The default value is 10

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

The next_page_token value returned from a previous List request, if any.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements