Show / Hide Table of Contents

Class CuratorsResource.ReportsResource

The "reports" collection of methods.

Inheritance
object
CuratorsResource.ReportsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CurationPartners.v1
Assembly: Google.Apis.CurationPartners.v1.dll
Syntax
public class CuratorsResource.ReportsResource

Constructors

ReportsResource(IClientService)

Constructs a new resource.

Declaration
public ReportsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

Operations

Gets the Operations resource.

Declaration
public virtual CuratorsResource.ReportsResource.OperationsResource Operations { get; }
Property Value
Type Description
CuratorsResource.ReportsResource.OperationsResource

Results

Gets the Results resource.

Declaration
public virtual CuratorsResource.ReportsResource.ResultsResource Results { get; }
Property Value
Type Description
CuratorsResource.ReportsResource.ResultsResource

Methods

Create(Report, string)

Creates a Report object.

Declaration
public virtual CuratorsResource.ReportsResource.CreateRequest Create(Report body, string parent)
Parameters
Type Name Description
Report body

The body of the request.

string parent

Required. The parent resource where this Report will be created. Format: curators/{account_id}

Returns
Type Description
CuratorsResource.ReportsResource.CreateRequest

Delete(string)

Deletes a Report object.

Declaration
public virtual CuratorsResource.ReportsResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. Resource name of the report to delete. Format: curators/{account_id}/reports/{report_id}

Returns
Type Description
CuratorsResource.ReportsResource.DeleteRequest

Get(string)

Retrieves a Report object.

Declaration
public virtual CuratorsResource.ReportsResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. The resource name of the report. Format: curators/{account_id}/reports/{report_id}

Returns
Type Description
CuratorsResource.ReportsResource.GetRequest

List(string)

Lists Report objects.

Declaration
public virtual CuratorsResource.ReportsResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. The parent, which owns this collection of reports. Format: curators/{account_id}

Returns
Type Description
CuratorsResource.ReportsResource.ListRequest

Patch(Report, string)

Updates a Report object.

Declaration
public virtual CuratorsResource.ReportsResource.PatchRequest Patch(Report body, string name)
Parameters
Type Name Description
Report body

The body of the request.

string name

Identifier. The resource name of the report. Report resource name have the form: curators/{account_id}/reports/{report_id}

Returns
Type Description
CuratorsResource.ReportsResource.PatchRequest

Run(RunReportRequest, string)

Initiates the execution of an existing report asynchronously. Users can get the report by polling this operation using OperationsService.GetOperation. Poll every 5 seconds initially, with an exponential backoff. Once a report is complete, the operation will contain a RunReportResponse in its response field containing a report_result that can be passed to the FetchReportResultRows method to retrieve the report data.

Declaration
public virtual CuratorsResource.ReportsResource.RunRequest Run(RunReportRequest body, string name)
Parameters
Type Name Description
RunReportRequest body

The body of the request.

string name

Required. The report to run. Format: curators/{account_id}/reports/{report_id}

Returns
Type Description
CuratorsResource.ReportsResource.RunRequest
In this article
Back to top Generated by DocFX