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

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
pulumi/pulumi-google-native

google-native.apigee/v1.Report

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
pulumi/pulumi-google-native

    Creates a Custom Report for an Organization. A Custom Report provides Apigee Customers to create custom dashboards in addition to the standard dashboards which are provided. The Custom Report in its simplest form contains specifications about metrics, dimensions and filters. It is important to note that the custom report by itself does not provide an executable entity. The Edge UI converts the custom report definition into an analytics query and displays the result in a chart.

    Create Report Resource

    new Report(name: string, args: ReportArgs, opts?: CustomResourceOptions);
    @overload
def Report(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           chart_type: Optional[str] = None,
           comments: Optional[Sequence[str]] = None,
           dimensions: Optional[Sequence[str]] = None,
           display_name: Optional[str] = None,
           filter: Optional[str] = None,
           from_time: Optional[str] = None,
           limit: Optional[str] = None,
           metrics: Optional[Sequence[GoogleCloudApigeeV1CustomReportMetricArgs]] = None,
           name: Optional[str] = None,
           offset: Optional[str] = None,
           organization_id: Optional[str] = None,
           properties: Optional[Sequence[GoogleCloudApigeeV1ReportPropertyArgs]] = None,
           sort_by_cols: Optional[Sequence[str]] = None,
           sort_order: Optional[str] = None,
           tags: Optional[Sequence[str]] = None,
           time_unit: Optional[str] = None,
           to_time: Optional[str] = None,
           topk: Optional[str] = None)
@overload
def Report(resource_name: str,
           args: ReportArgs,
           opts: Optional[ResourceOptions] = None)
    func NewReport(ctx *Context, name string, args ReportArgs, opts ...ResourceOption) (*Report, error)
    public Report(string name, ReportArgs args, CustomResourceOptions? opts = null)
    public Report(String name, ReportArgs args)
public Report(String name, ReportArgs args, CustomResourceOptions options)

    type: google-native:apigee/v1:Report
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ReportArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ReportArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReportArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Report Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Report resource accepts the following input properties:

    Metrics List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1CustomReportMetric>

    This contains the list of metrics

    OrganizationId string
    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

    Dimensions List<string>

    This contains the list of dimensions for the report

    DisplayName string

    This is the display name for the report

    Filter string

    This field contains the filter expression

    FromTime string

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

    Limit string

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

    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

    Properties List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1ReportProperty>

    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

    Metrics []GoogleCloudApigeeV1CustomReportMetricArgs

    This contains the list of metrics

    OrganizationId string
    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

    Dimensions []string

    This contains the list of dimensions for the report

    DisplayName string

    This is the display name for the report

    Filter string

    This field contains the filter expression

    FromTime string

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

    Limit string

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

    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

    Properties []GoogleCloudApigeeV1ReportPropertyArgs

    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

    metrics List<GoogleCloudApigeeV1CustomReportMetric>

    This contains the list of metrics

    organizationId String
    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

    dimensions List<String>

    This contains the list of dimensions for the report

    displayName String

    This is the display name for the report

    filter String

    This field contains the filter expression

    fromTime String

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

    limit String

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

    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

    properties List<GoogleCloudApigeeV1ReportProperty>

    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

    metrics GoogleCloudApigeeV1CustomReportMetric[]

    This contains the list of metrics

    organizationId string
    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

    dimensions string[]

    This contains the list of dimensions for the report

    displayName string

    This is the display name for the report

    filter string

    This field contains the filter expression

    fromTime string

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

    limit string

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

    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

    properties GoogleCloudApigeeV1ReportProperty[]

    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

    metrics Sequence[GoogleCloudApigeeV1CustomReportMetricArgs]

    This contains the list of metrics

    organization_id str
    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

    dimensions Sequence[str]

    This contains the list of dimensions for the report

    display_name str

    This is the display name for the report

    filter str

    This field contains the filter expression

    from_time str

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

    limit str

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

    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

    properties Sequence[GoogleCloudApigeeV1ReportPropertyArgs]

    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

    metrics List<Property Map>

    This contains the list of metrics

    organizationId String
    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

    dimensions List<String>

    This contains the list of dimensions for the report

    displayName String

    This is the display name for the report

    filter String

    This field contains the filter expression

    fromTime String

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

    limit String

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

    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

    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

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Report resource produces the following output properties:

    CreatedAt string

    Unix time when the app was created json key: createdAt

    Environment string

    Environment name

    Id string

    The provider-assigned unique ID for this managed resource.

    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

    Organization string

    Organization name

    CreatedAt string

    Unix time when the app was created json key: createdAt

    Environment string

    Environment name

    Id string

    The provider-assigned unique ID for this managed resource.

    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

    Organization string

    Organization name

    createdAt String

    Unix time when the app was created json key: createdAt

    environment String

    Environment name

    id String

    The provider-assigned unique ID for this managed resource.

    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

    organization String

    Organization name

    createdAt string

    Unix time when the app was created json key: createdAt

    environment string

    Environment name

    id string

    The provider-assigned unique ID for this managed resource.

    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

    organization string

    Organization name

    created_at str

    Unix time when the app was created json key: createdAt

    environment str

    Environment name

    id str

    The provider-assigned unique ID for this managed resource.

    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

    organization str

    Organization name

    createdAt String

    Unix time when the app was created json key: createdAt

    environment String

    Environment name

    id String

    The provider-assigned unique ID for this managed resource.

    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

    organization String

    Organization name

    Supporting Types

    GoogleCloudApigeeV1Attribute, GoogleCloudApigeeV1AttributeArgs

    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.

    GoogleCloudApigeeV1AttributeResponse, GoogleCloudApigeeV1AttributeResponseArgs

    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.

    GoogleCloudApigeeV1CustomReportMetric, GoogleCloudApigeeV1CustomReportMetricArgs

    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

    GoogleCloudApigeeV1CustomReportMetricResponse, GoogleCloudApigeeV1CustomReportMetricResponseArgs

    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

    GoogleCloudApigeeV1ReportProperty, GoogleCloudApigeeV1ReportPropertyArgs

    Property string

    name of the property

    Value []GoogleCloudApigeeV1Attribute

    property values

    property String

    name of the property

    value List<GoogleCloudApigeeV1Attribute>

    property values

    property string

    name of the property

    value GoogleCloudApigeeV1Attribute[]

    property values

    property str

    name of the property

    value Sequence[GoogleCloudApigeeV1Attribute]

    property values

    property String

    name of the property

    value List<Property Map>

    property values

    GoogleCloudApigeeV1ReportPropertyResponse, GoogleCloudApigeeV1ReportPropertyResponseArgs

    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
    pulumi/pulumi-google-native