Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityReportQuery

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

Overview

Body structure when user makes a request to create a security report.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1SecurityReportQuery

Returns a new instance of GoogleCloudApigeeV1SecurityReportQuery.



12009
12010
12011
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 12009

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

Instance Attribute Details

#csv_delimiter ⇒ String

Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t). Corresponds to the JSON property csvDelimiter

Returns:

  • (String) 


11938
11939
11940
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 11938

def csv_delimiter
  @csv_delimiter
end

#dimensions ⇒ Array<String>

A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics- reference#dimensions Corresponds to the JSON property dimensions

Returns:

  • (Array<String>) 


11944
11945
11946
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 11944

def dimensions
  @dimensions
end

#display_name ⇒ String

Security Report display name which users can specify. Corresponds to the JSON property displayName

Returns:

  • (String) 


11949
11950
11951
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 11949

def display_name
  @display_name
end

#envgroup_hostname ⇒ String

Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostSecurityReport where analytics data will be grouped by organization and hostname. Corresponds to the JSON property envgroupHostname

Returns:

  • (String) 


11956
11957
11958
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 11956

def envgroup_hostname
  @envgroup_hostname
end

#filter ⇒ String

Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https:// docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter- expression-syntax Corresponds to the JSON property filter

Returns:

  • (String) 


11968
11969
11970
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 11968

def filter
  @filter
end

#group_by_time_unit ⇒ String

Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision. Corresponds to the JSON property groupByTimeUnit

Returns:

  • (String) 


11977
11978
11979
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 11977

def group_by_time_unit
  @group_by_time_unit
end

#limit ⇒ Fixnum

Maximum number of rows that can be returned in the result. Corresponds to the JSON property limit

Returns:

  • (Fixnum) 


11982
11983
11984
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 11982

def limit
  @limit
end

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

A list of Metrics. Corresponds to the JSON property metrics

Returns:



11987
11988
11989
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 11987

def metrics
  @metrics
end

#mime_type ⇒ String

Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property. Corresponds to the JSON property mimeType

Returns:

  • (String) 


11993
11994
11995
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 11993

def mime_type
  @mime_type
end

#report_definition_id ⇒ String

Report Definition ID. Corresponds to the JSON property reportDefinitionId

Returns:

  • (String) 


11998
11999
12000
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 11998

def report_definition_id
  @report_definition_id
end

#time_range ⇒ Object

Required. Time range for the query. Can use the following predefined strings to specify the time range: last60minutes last24hours last7days Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": "start": "2018- 07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" Corresponds to the JSON property timeRange

Returns:

  • (Object) 


12007
12008
12009
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 12007

def time_range
  @time_range
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 12014

def update!(**args)
  @csv_delimiter = args[:csv_delimiter] if args.key?(:csv_delimiter)
  @dimensions = args[:dimensions] if args.key?(:dimensions)
  @display_name = args[:display_name] if args.key?(:display_name)
  @envgroup_hostname = args[:envgroup_hostname] if args.key?(:envgroup_hostname)
  @filter = args[:filter] if args.key?(:filter)
  @group_by_time_unit = args[:group_by_time_unit] if args.key?(:group_by_time_unit)
  @limit = args[:limit] if args.key?(:limit)
  @metrics = args[:metrics] if args.key?(:metrics)
  @mime_type = args[:mime_type] if args.key?(:mime_type)
  @report_definition_id = args[:report_definition_id] if args.key?(:report_definition_id)
  @time_range = args[:time_range] if args.key?(:time_range)
end