1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigee
  5. apigee/v1
  6. getReport

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

google-native.apigee/v1.getReport

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

    Retrieve a custom report definition.

    Using getReport

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getReport(args: GetReportArgs, opts?: InvokeOptions): Promise<GetReportResult>
    function getReportOutput(args: GetReportOutputArgs, opts?: InvokeOptions): Output<GetReportResult>
    def get_report(organization_id: Optional[str] = None,
                   report_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetReportResult
    def get_report_output(organization_id: Optional[pulumi.Input[str]] = None,
                   report_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetReportResult]
    func LookupReport(ctx *Context, args *LookupReportArgs, opts ...InvokeOption) (*LookupReportResult, error)
    func LookupReportOutput(ctx *Context, args *LookupReportOutputArgs, opts ...InvokeOption) LookupReportResultOutput

    > Note: This function is named LookupReport in the Go SDK.

    public static class GetReport 
    {
        public static Task<GetReportResult> InvokeAsync(GetReportArgs args, InvokeOptions? opts = null)
        public static Output<GetReportResult> Invoke(GetReportInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetReportResult> getReport(GetReportArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: google-native:apigee/v1:getReport
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getReport Result

    The following output properties are available:

    ChartType string

    This field contains the chart type for the report

    Comments List<string>

    Legacy field: not used. This field contains a list of comments associated with custom report

    CreatedAt string

    Unix time when the app was created json key: createdAt

    Dimensions List<string>

    This contains the list of dimensions for the report

    DisplayName string

    This is the display name for the report

    Environment string

    Environment name

    Filter string

    This field contains the filter expression

    FromTime string

    Legacy field: not used. Contains the from time for the report

    LastModifiedAt string

    Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt

    LastViewedAt string

    Last viewed time of this entity as milliseconds since epoch

    Limit string

    Legacy field: not used This field contains the limit for the result retrieved

    Metrics List<Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1CustomReportMetricResponse>

    This contains the list of metrics

    Name string

    Unique identifier for the report T his is a legacy field used to encode custom report unique id

    Offset string

    Legacy field: not used. This field contains the offset for the data

    Organization string

    Organization name

    Properties List<Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1ReportPropertyResponse>

    This field contains report properties such as ui metadata etc.

    SortByCols List<string>

    Legacy field: not used much. Contains the list of sort by columns

    SortOrder string

    Legacy field: not used much. Contains the sort order for the sort columns

    Tags List<string>

    Legacy field: not used. This field contains a list of tags associated with custom report

    TimeUnit string

    This field contains the time unit of aggregation for the report

    ToTime string

    Legacy field: not used. Contains the end time for the report

    Topk string

    Legacy field: not used. This field contains the top k parameter value for restricting the result

    ChartType string

    This field contains the chart type for the report

    Comments []string

    Legacy field: not used. This field contains a list of comments associated with custom report

    CreatedAt string

    Unix time when the app was created json key: createdAt

    Dimensions []string

    This contains the list of dimensions for the report

    DisplayName string

    This is the display name for the report

    Environment string

    Environment name

    Filter string

    This field contains the filter expression

    FromTime string

    Legacy field: not used. Contains the from time for the report

    LastModifiedAt string

    Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt

    LastViewedAt string

    Last viewed time of this entity as milliseconds since epoch

    Limit string

    Legacy field: not used This field contains the limit for the result retrieved

    Metrics []GoogleCloudApigeeV1CustomReportMetricResponse

    This contains the list of metrics

    Name string

    Unique identifier for the report T his is a legacy field used to encode custom report unique id

    Offset string

    Legacy field: not used. This field contains the offset for the data

    Organization string

    Organization name

    Properties []GoogleCloudApigeeV1ReportPropertyResponse

    This field contains report properties such as ui metadata etc.

    SortByCols []string

    Legacy field: not used much. Contains the list of sort by columns

    SortOrder string

    Legacy field: not used much. Contains the sort order for the sort columns

    Tags []string

    Legacy field: not used. This field contains a list of tags associated with custom report

    TimeUnit string

    This field contains the time unit of aggregation for the report

    ToTime string

    Legacy field: not used. Contains the end time for the report

    Topk string

    Legacy field: not used. This field contains the top k parameter value for restricting the result

    chartType String

    This field contains the chart type for the report

    comments List<String>

    Legacy field: not used. This field contains a list of comments associated with custom report

    createdAt String

    Unix time when the app was created json key: createdAt

    dimensions List<String>

    This contains the list of dimensions for the report

    displayName String

    This is the display name for the report

    environment String

    Environment name

    filter String

    This field contains the filter expression

    fromTime String

    Legacy field: not used. Contains the from time for the report

    lastModifiedAt String

    Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt

    lastViewedAt String

    Last viewed time of this entity as milliseconds since epoch

    limit String

    Legacy field: not used This field contains the limit for the result retrieved

    metrics List<GoogleCloudApigeeV1CustomReportMetricResponse>

    This contains the list of metrics

    name String

    Unique identifier for the report T his is a legacy field used to encode custom report unique id

    offset String

    Legacy field: not used. This field contains the offset for the data

    organization String

    Organization name

    properties List<GoogleCloudApigeeV1ReportPropertyResponse>

    This field contains report properties such as ui metadata etc.

    sortByCols List<String>

    Legacy field: not used much. Contains the list of sort by columns

    sortOrder String

    Legacy field: not used much. Contains the sort order for the sort columns

    tags List<String>

    Legacy field: not used. This field contains a list of tags associated with custom report

    timeUnit String

    This field contains the time unit of aggregation for the report

    toTime String

    Legacy field: not used. Contains the end time for the report

    topk String

    Legacy field: not used. This field contains the top k parameter value for restricting the result

    chartType string

    This field contains the chart type for the report

    comments string[]

    Legacy field: not used. This field contains a list of comments associated with custom report

    createdAt string

    Unix time when the app was created json key: createdAt

    dimensions string[]

    This contains the list of dimensions for the report

    displayName string

    This is the display name for the report

    environment string

    Environment name

    filter string

    This field contains the filter expression

    fromTime string

    Legacy field: not used. Contains the from time for the report

    lastModifiedAt string

    Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt

    lastViewedAt string

    Last viewed time of this entity as milliseconds since epoch

    limit string

    Legacy field: not used This field contains the limit for the result retrieved

    metrics GoogleCloudApigeeV1CustomReportMetricResponse[]

    This contains the list of metrics

    name string

    Unique identifier for the report T his is a legacy field used to encode custom report unique id

    offset string

    Legacy field: not used. This field contains the offset for the data

    organization string

    Organization name

    properties GoogleCloudApigeeV1ReportPropertyResponse[]

    This field contains report properties such as ui metadata etc.

    sortByCols string[]

    Legacy field: not used much. Contains the list of sort by columns

    sortOrder string

    Legacy field: not used much. Contains the sort order for the sort columns

    tags string[]

    Legacy field: not used. This field contains a list of tags associated with custom report

    timeUnit string

    This field contains the time unit of aggregation for the report

    toTime string

    Legacy field: not used. Contains the end time for the report

    topk string

    Legacy field: not used. This field contains the top k parameter value for restricting the result

    chart_type str

    This field contains the chart type for the report

    comments Sequence[str]

    Legacy field: not used. This field contains a list of comments associated with custom report

    created_at str

    Unix time when the app was created json key: createdAt

    dimensions Sequence[str]

    This contains the list of dimensions for the report

    display_name str

    This is the display name for the report

    environment str

    Environment name

    filter str

    This field contains the filter expression

    from_time str

    Legacy field: not used. Contains the from time for the report

    last_modified_at str

    Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt

    last_viewed_at str

    Last viewed time of this entity as milliseconds since epoch

    limit str

    Legacy field: not used This field contains the limit for the result retrieved

    metrics Sequence[GoogleCloudApigeeV1CustomReportMetricResponse]

    This contains the list of metrics

    name str

    Unique identifier for the report T his is a legacy field used to encode custom report unique id

    offset str

    Legacy field: not used. This field contains the offset for the data

    organization str

    Organization name

    properties Sequence[GoogleCloudApigeeV1ReportPropertyResponse]

    This field contains report properties such as ui metadata etc.

    sort_by_cols Sequence[str]

    Legacy field: not used much. Contains the list of sort by columns

    sort_order str

    Legacy field: not used much. Contains the sort order for the sort columns

    tags Sequence[str]

    Legacy field: not used. This field contains a list of tags associated with custom report

    time_unit str

    This field contains the time unit of aggregation for the report

    to_time str

    Legacy field: not used. Contains the end time for the report

    topk str

    Legacy field: not used. This field contains the top k parameter value for restricting the result

    chartType String

    This field contains the chart type for the report

    comments List<String>

    Legacy field: not used. This field contains a list of comments associated with custom report

    createdAt String

    Unix time when the app was created json key: createdAt

    dimensions List<String>

    This contains the list of dimensions for the report

    displayName String

    This is the display name for the report

    environment String

    Environment name

    filter String

    This field contains the filter expression

    fromTime String

    Legacy field: not used. Contains the from time for the report

    lastModifiedAt String

    Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt

    lastViewedAt String

    Last viewed time of this entity as milliseconds since epoch

    limit String

    Legacy field: not used This field contains the limit for the result retrieved

    metrics List<Property Map>

    This contains the list of metrics

    name String

    Unique identifier for the report T his is a legacy field used to encode custom report unique id

    offset String

    Legacy field: not used. This field contains the offset for the data

    organization String

    Organization name

    properties List<Property Map>

    This field contains report properties such as ui metadata etc.

    sortByCols List<String>

    Legacy field: not used much. Contains the list of sort by columns

    sortOrder String

    Legacy field: not used much. Contains the sort order for the sort columns

    tags List<String>

    Legacy field: not used. This field contains a list of tags associated with custom report

    timeUnit String

    This field contains the time unit of aggregation for the report

    toTime String

    Legacy field: not used. Contains the end time for the report

    topk String

    Legacy field: not used. This field contains the top k parameter value for restricting the result

    Supporting Types

    GoogleCloudApigeeV1AttributeResponse

    Name string

    API key of the attribute.

    Value string

    Value of the attribute.

    Name string

    API key of the attribute.

    Value string

    Value of the attribute.

    name String

    API key of the attribute.

    value String

    Value of the attribute.

    name string

    API key of the attribute.

    value string

    Value of the attribute.

    name str

    API key of the attribute.

    value str

    Value of the attribute.

    name String

    API key of the attribute.

    value String

    Value of the attribute.

    GoogleCloudApigeeV1CustomReportMetricResponse

    Function string

    aggregate function

    Name string

    name of the metric

    Function string

    aggregate function

    Name string

    name of the metric

    function String

    aggregate function

    name String

    name of the metric

    function string

    aggregate function

    name string

    name of the metric

    function str

    aggregate function

    name str

    name of the metric

    function String

    aggregate function

    name String

    name of the metric

    GoogleCloudApigeeV1ReportPropertyResponse

    Property string

    name of the property

    Value []GoogleCloudApigeeV1AttributeResponse

    property values

    property String

    name of the property

    value List<GoogleCloudApigeeV1AttributeResponse>

    property values

    property string

    name of the property

    value GoogleCloudApigeeV1AttributeResponse[]

    property values

    property str

    name of the property

    value Sequence[GoogleCloudApigeeV1AttributeResponse]

    property values

    property String

    name of the property

    value List<Property Map>

    property values

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi