Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
google-native.apigee/v1.getReport
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 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)
public static Output<GetReportResult> getReport(GetReportArgs args, InvokeOptions options)
fn::invoke:
  function: google-native:apigee/v1:getReport
  arguments:
    # arguments dictionaryThe following arguments are supported:
- OrganizationId string
- ReportId string
- OrganizationId string
- ReportId string
- organizationId String
- reportId String
- organizationId string
- reportId string
- organization_id str
- report_id str
- organizationId String
- reportId String
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
- LastModified stringAt 
- Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt
- LastViewed stringAt 
- 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.Google Native. Apigee. V1. Outputs. Google Cloud Apigee V1Custom Report Metric Response> 
- 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.Google Native. Apigee. V1. Outputs. Google Cloud Apigee V1Report Property Response> 
- This field contains report properties such as ui metadata etc.
- SortBy List<string>Cols 
- 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
- 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
- LastModified stringAt 
- Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt
- LastViewed stringAt 
- 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
[]GoogleCloud Apigee V1Custom Report Metric Response 
- 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
[]GoogleCloud Apigee V1Report Property Response 
- This field contains report properties such as ui metadata etc.
- SortBy []stringCols 
- 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
- []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
- lastModified StringAt 
- Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt
- lastViewed StringAt 
- 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<GoogleCloud Apigee V1Custom Report Metric Response> 
- 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<GoogleCloud Apigee V1Report Property Response> 
- This field contains report properties such as ui metadata etc.
- sortBy List<String>Cols 
- 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
- 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
- lastModified stringAt 
- Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt
- lastViewed stringAt 
- 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
GoogleCloud Apigee V1Custom Report Metric Response[] 
- 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
GoogleCloud Apigee V1Report Property Response[] 
- This field contains report properties such as ui metadata etc.
- sortBy string[]Cols 
- 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
- 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_ strat 
- Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt
- last_viewed_ strat 
- 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[GoogleCloud Apigee V1Custom Report Metric Response] 
- 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[GoogleCloud Apigee V1Report Property Response] 
- This field contains report properties such as ui metadata etc.
- sort_by_ Sequence[str]cols 
- 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
- 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
- lastModified StringAt 
- Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt
- lastViewed StringAt 
- 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.
- sortBy List<String>Cols 
- 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
- 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    
GoogleCloudApigeeV1CustomReportMetricResponse      
GoogleCloudApigeeV1ReportPropertyResponse     
- Property string
- name of the property
- Value
List<Pulumi.Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Attribute Response> 
- property values
- Property string
- name of the property
- Value
[]GoogleCloud Apigee V1Attribute Response 
- property values
- property String
- name of the property
- value
List<GoogleCloud Apigee V1Attribute Response> 
- property values
- property string
- name of the property
- value
GoogleCloud Apigee V1Attribute Response[] 
- property values
- property str
- name of the property
- value
Sequence[GoogleCloud Apigee V1Attribute Response] 
- 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 Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi