Class StatsResource.GetIndexRequest
Gets indexed item statistics aggreggated across all data sources. This API only returns statistics for previous dates; it doesn't return statistics for the current day. Note: This API requires a standard end user account to execute.
Inheritance
System.Object
StatsResource.GetIndexRequest
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.CloudSearch.v1
Assembly: Google.Apis.CloudSearch.v1.dll
Syntax
public class GetIndexRequest : CloudSearchBaseServiceRequest<GetCustomerIndexStatsResponse>, IClientServiceRequest<GetCustomerIndexStatsResponse>, IClientServiceRequest
Constructors
GetIndexRequest(IClientService)
Constructs a new GetIndex request.
Declaration
public GetIndexRequest(IClientService service)
Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service |
Properties
FromDateDay
Day of month. Must be from 1 to 31 and valid for the year and month.
Declaration
[RequestParameter("fromDate.day", RequestParameterType.Query)]
public virtual int? FromDateDay { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
FromDateMonth
Month of date. Must be from 1 to 12.
Declaration
[RequestParameter("fromDate.month", RequestParameterType.Query)]
public virtual int? FromDateMonth { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
FromDateYear
Year of date. Must be from 1 to 9999.
Declaration
[RequestParameter("fromDate.year", RequestParameterType.Query)]
public virtual int? FromDateYear { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.GetCustomerIndexStatsResponse>.HttpMethod
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.GetCustomerIndexStatsResponse>.MethodName
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudSearch.v1.Data.GetCustomerIndexStatsResponse>.RestPath
ToDateDay
Day of month. Must be from 1 to 31 and valid for the year and month.
Declaration
[RequestParameter("toDate.day", RequestParameterType.Query)]
public virtual int? ToDateDay { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
ToDateMonth
Month of date. Must be from 1 to 12.
Declaration
[RequestParameter("toDate.month", RequestParameterType.Query)]
public virtual int? ToDateMonth { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
ToDateYear
Year of date. Must be from 1 to 9999.
Declaration
[RequestParameter("toDate.year", RequestParameterType.Query)]
public virtual int? ToDateYear { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
Methods
InitParameters()
Initializes GetIndex parameter list.
Declaration
protected override void InitParameters()
Overrides
Google.Apis.CloudSearch.v1.CloudSearchBaseServiceRequest<Google.Apis.CloudSearch.v1.Data.GetCustomerIndexStatsResponse>.InitParameters()