Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/apigee_v1/classes.rb,
lib/google/apis/apigee_v1/representations.rb,
lib/google/apis/apigee_v1/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1CustomReport

Returns a new instance of GoogleCloudApigeeV1CustomReport.



1691
1692
1693
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1691

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#chart_type ⇒ String

This field contains the chart type for the report Corresponds to the JSON property chartType

Returns:

  • (String) 


1579
1580
1581
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1579

def chart_type
  @chart_type
end

#comments ⇒ Array<String>

Legacy field: not used. This field contains a list of comments associated with custom report Corresponds to the JSON property comments

Returns:

  • (Array<String>) 


1585
1586
1587
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1585

def comments
  @comments
end

#created_at ⇒ Fixnum

Output only. Unix time when the app was created json key: createdAt Corresponds to the JSON property createdAt

Returns:

  • (Fixnum) 


1590
1591
1592
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1590

def created_at
  @created_at
end

#dimensions ⇒ Array<String>

This contains the list of dimensions for the report Corresponds to the JSON property dimensions

Returns:

  • (Array<String>) 


1595
1596
1597
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1595

def dimensions
  @dimensions
end

#display_name ⇒ String

This is the display name for the report Corresponds to the JSON property displayName

Returns:

  • (String) 


1600
1601
1602
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1600

def display_name
  @display_name
end

#environment ⇒ String

Output only. Environment name Corresponds to the JSON property environment

Returns:

  • (String) 


1605
1606
1607
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1605

def environment
  @environment
end

#filter ⇒ String

This field contains the filter expression Corresponds to the JSON property filter

Returns:

  • (String) 


1610
1611
1612
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1610

def filter
  @filter
end

#from_time ⇒ String

Legacy field: not used. Contains the from time for the report Corresponds to the JSON property fromTime

Returns:

  • (String) 


1615
1616
1617
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1615

def from_time
  @from_time
end

#last_modified_at ⇒ Fixnum

Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt Corresponds to the JSON property lastModifiedAt

Returns:

  • (Fixnum) 


1621
1622
1623
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1621

def last_modified_at
  @last_modified_at
end

#last_viewed_at ⇒ Fixnum

Output only. Last viewed time of this entity as milliseconds since epoch Corresponds to the JSON property lastViewedAt

Returns:

  • (Fixnum) 


1626
1627
1628
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1626

def last_viewed_at
  @last_viewed_at
end

#limit ⇒ String

Legacy field: not used This field contains the limit for the result retrieved Corresponds to the JSON property limit

Returns:

  • (String) 


1631
1632
1633
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1631

def limit
  @limit
end

#metrics ⇒ Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReportMetric>

Required. This contains the list of metrics Corresponds to the JSON property metrics

Returns:



1636
1637
1638
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1636

def metrics
  @metrics
end

#name ⇒ String

Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id Corresponds to the JSON property name

Returns:

  • (String) 


1642
1643
1644
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1642

def name
  @name
end

#offset ⇒ String

Legacy field: not used. This field contains the offset for the data Corresponds to the JSON property offset

Returns:

  • (String) 


1647
1648
1649
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1647

def offset
  @offset
end

#organization ⇒ String

Output only. Organization name Corresponds to the JSON property organization

Returns:

  • (String) 


1652
1653
1654
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1652

def organization
  @organization
end

#properties ⇒ Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReportProperty>

This field contains report properties such as ui metadata etc. Corresponds to the JSON property properties

Returns:



1657
1658
1659
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1657

def properties
  @properties
end

#sort_by_cols ⇒ Array<String>

Legacy field: not used much. Contains the list of sort by columns Corresponds to the JSON property sortByCols

Returns:

  • (Array<String>) 


1662
1663
1664
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1662

def sort_by_cols
  @sort_by_cols
end

#sort_order ⇒ String

Legacy field: not used much. Contains the sort order for the sort columns Corresponds to the JSON property sortOrder

Returns:

  • (String) 


1667
1668
1669
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1667

def sort_order
  @sort_order
end

#tags ⇒ Array<String>

Legacy field: not used. This field contains a list of tags associated with custom report Corresponds to the JSON property tags

Returns:

  • (Array<String>) 


1673
1674
1675
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1673

def tags
  @tags
end

#time_unit ⇒ String

This field contains the time unit of aggregation for the report Corresponds to the JSON property timeUnit

Returns:

  • (String) 


1678
1679
1680
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1678

def time_unit
  @time_unit
end

#to_time ⇒ String

Legacy field: not used. Contains the end time for the report Corresponds to the JSON property toTime

Returns:

  • (String) 


1683
1684
1685
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1683

def to_time
  @to_time
end

#topk ⇒ String

Legacy field: not used. This field contains the top k parameter value for restricting the result Corresponds to the JSON property topk

Returns:

  • (String) 


1689
1690
1691
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1689

def topk
  @topk
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1696

def update!(**args)
  @chart_type = args[:chart_type] if args.key?(:chart_type)
  @comments = args[:comments] if args.key?(:comments)
  @created_at = args[:created_at] if args.key?(:created_at)
  @dimensions = args[:dimensions] if args.key?(:dimensions)
  @display_name = args[:display_name] if args.key?(:display_name)
  @environment = args[:environment] if args.key?(:environment)
  @filter = args[:filter] if args.key?(:filter)
  @from_time = args[:from_time] if args.key?(:from_time)
  @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at)
  @last_viewed_at = args[:last_viewed_at] if args.key?(:last_viewed_at)
  @limit = args[:limit] if args.key?(:limit)
  @metrics = args[:metrics] if args.key?(:metrics)
  @name = args[:name] if args.key?(:name)
  @offset = args[:offset] if args.key?(:offset)
  @organization = args[:organization] if args.key?(:organization)
  @properties = args[:properties] if args.key?(:properties)
  @sort_by_cols = args[:sort_by_cols] if args.key?(:sort_by_cols)
  @sort_order = args[:sort_order] if args.key?(:sort_order)
  @tags = args[:tags] if args.key?(:tags)
  @time_unit = args[:time_unit] if args.key?(:time_unit)
  @to_time = args[:to_time] if args.key?(:to_time)
  @topk = args[:topk] if args.key?(:topk)
end