Class: Azure::PolicyInsights::Mgmt::V2018_04_04::Models::QueryOptions

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-04-04/generated/azure_mgmt_policy_insights/models/query_options.rb

Overview

Additional parameters for a set of operations.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#applyString

Returns OData apply expression for aggregations.

Returns:

  • (String)

    OData apply expression for aggregations.



42
43
44
# File 'lib/2018-04-04/generated/azure_mgmt_policy_insights/models/query_options.rb', line 42

def apply
  @apply
end

#filterString

Returns OData filter expression.

Returns:

  • (String)

    OData filter expression.



39
40
41
# File 'lib/2018-04-04/generated/azure_mgmt_policy_insights/models/query_options.rb', line 39

def filter
  @filter
end

#fromDateTime

time of the interval to query. When not specified, the service uses ($to - 1-day).

Returns:

  • (DateTime)

    ISO 8601 formatted timestamp specifying the start



31
32
33
# File 'lib/2018-04-04/generated/azure_mgmt_policy_insights/models/query_options.rb', line 31

def from
  @from
end

#order_byString

comma-separated column names with an optional “desc” (the default) or “asc”, e.g. “$orderby=PolicyAssignmentId, ResourceId asc”.

Returns:

  • (String)

    Ordering expression using OData notation. One or more



21
22
23
# File 'lib/2018-04-04/generated/azure_mgmt_policy_insights/models/query_options.rb', line 21

def order_by
  @order_by
end

#selectString

columns on each record to just those requested, e.g. “$select=PolicyAssignmentId, ResourceId”.

Returns:

  • (String)

    Select expression using OData notation. Limits the



26
27
28
# File 'lib/2018-04-04/generated/azure_mgmt_policy_insights/models/query_options.rb', line 26

def select
  @select
end

#toDateTime

of the interval to query. When not specified, the service uses request time.

Returns:

  • (DateTime)

    ISO 8601 formatted timestamp specifying the end time



36
37
38
# File 'lib/2018-04-04/generated/azure_mgmt_policy_insights/models/query_options.rb', line 36

def to
  @to
end

#topInteger

Returns Maximum number of records to return.

Returns:

  • (Integer)

    Maximum number of records to return.



16
17
18
# File 'lib/2018-04-04/generated/azure_mgmt_policy_insights/models/query_options.rb', line 16

def top
  @top
end

Class Method Details

.mapperObject

Mapper for QueryOptions class as Ruby Hash. This will be used for serialization/deserialization.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# File 'lib/2018-04-04/generated/azure_mgmt_policy_insights/models/query_options.rb', line 49

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    type: {
      name: 'Composite',
      class_name: 'QueryOptions',
      model_properties: {
        top: {
          client_side_validation: true,
          required: false,
          type: {
            name: 'Number'
          }
        },
        order_by: {
          client_side_validation: true,
          required: false,
          type: {
            name: 'String'
          }
        },
        select: {
          client_side_validation: true,
          required: false,
          type: {
            name: 'String'
          }
        },
        from: {
          client_side_validation: true,
          required: false,
          type: {
            name: 'DateTime'
          }
        },
        to: {
          client_side_validation: true,
          required: false,
          type: {
            name: 'DateTime'
          }
        },
        filter: {
          client_side_validation: true,
          required: false,
          type: {
            name: 'String'
          }
        },
        apply: {
          client_side_validation: true,
          required: false,
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end