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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1CustomReport

Returns a new instance of GoogleCloudApigeeV1CustomReport.



1287
1288
1289
# File 'generated/google/apis/apigee_v1/classes.rb', line 1287

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

Instance Attribute Details

#chart_typeString

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

Returns:

  • (String)


1173
1174
1175
# File 'generated/google/apis/apigee_v1/classes.rb', line 1173

def chart_type
  @chart_type
end

#commentsArray<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>)


1179
1180
1181
# File 'generated/google/apis/apigee_v1/classes.rb', line 1179

def comments
  @comments
end

#created_atFixnum

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

Returns:

  • (Fixnum)


1185
1186
1187
# File 'generated/google/apis/apigee_v1/classes.rb', line 1185

def created_at
  @created_at
end

#dimensionsArray<String>

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

Returns:

  • (Array<String>)


1190
1191
1192
# File 'generated/google/apis/apigee_v1/classes.rb', line 1190

def dimensions
  @dimensions
end

#display_nameString

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

Returns:

  • (String)


1195
1196
1197
# File 'generated/google/apis/apigee_v1/classes.rb', line 1195

def display_name
  @display_name
end

#environmentString

Output only. Environment name Corresponds to the JSON property environment

Returns:

  • (String)


1200
1201
1202
# File 'generated/google/apis/apigee_v1/classes.rb', line 1200

def environment
  @environment
end

#filterString

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

Returns:

  • (String)


1205
1206
1207
# File 'generated/google/apis/apigee_v1/classes.rb', line 1205

def filter
  @filter
end

#from_timeString

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

Returns:

  • (String)


1210
1211
1212
# File 'generated/google/apis/apigee_v1/classes.rb', line 1210

def from_time
  @from_time
end

#last_modified_atFixnum

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

Returns:

  • (Fixnum)


1216
1217
1218
# File 'generated/google/apis/apigee_v1/classes.rb', line 1216

def last_modified_at
  @last_modified_at
end

#last_viewed_atFixnum

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

Returns:

  • (Fixnum)


1221
1222
1223
# File 'generated/google/apis/apigee_v1/classes.rb', line 1221

def last_viewed_at
  @last_viewed_at
end

#limitString

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

Returns:

  • (String)


1227
1228
1229
# File 'generated/google/apis/apigee_v1/classes.rb', line 1227

def limit
  @limit
end

#metricsArray<Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReportMetric>

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



1232
1233
1234
# File 'generated/google/apis/apigee_v1/classes.rb', line 1232

def metrics
  @metrics
end

#nameString

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)


1238
1239
1240
# File 'generated/google/apis/apigee_v1/classes.rb', line 1238

def name
  @name
end

#offsetString

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

Returns:

  • (String)


1243
1244
1245
# File 'generated/google/apis/apigee_v1/classes.rb', line 1243

def offset
  @offset
end

#organizationString

Output only. Organization name Corresponds to the JSON property organization

Returns:

  • (String)


1248
1249
1250
# File 'generated/google/apis/apigee_v1/classes.rb', line 1248

def organization
  @organization
end

#propertiesArray<Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReportProperty>

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



1253
1254
1255
# File 'generated/google/apis/apigee_v1/classes.rb', line 1253

def properties
  @properties
end

#sort_by_colsArray<String>

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

Returns:

  • (Array<String>)


1258
1259
1260
# File 'generated/google/apis/apigee_v1/classes.rb', line 1258

def sort_by_cols
  @sort_by_cols
end

#sort_orderString

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

Returns:

  • (String)


1263
1264
1265
# File 'generated/google/apis/apigee_v1/classes.rb', line 1263

def sort_order
  @sort_order
end

#tagsArray<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>)


1269
1270
1271
# File 'generated/google/apis/apigee_v1/classes.rb', line 1269

def tags
  @tags
end

#time_unitString

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

Returns:

  • (String)


1274
1275
1276
# File 'generated/google/apis/apigee_v1/classes.rb', line 1274

def time_unit
  @time_unit
end

#to_timeString

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

Returns:

  • (String)


1279
1280
1281
# File 'generated/google/apis/apigee_v1/classes.rb', line 1279

def to_time
  @to_time
end

#topkString

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

Returns:

  • (String)


1285
1286
1287
# File 'generated/google/apis/apigee_v1/classes.rb', line 1285

def topk
  @topk
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
# File 'generated/google/apis/apigee_v1/classes.rb', line 1292

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