Class: Google::Apis::IamV1::LintResult

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

Overview

Structured response of a single validation unit.

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) ⇒ LintResult

Returns a new instance of LintResult



636
637
638
# File 'generated/google/apis/iam_v1/classes.rb', line 636

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

Instance Attribute Details

#binding_ordinalFixnum

0-based index ordinality of the binding in the input object associated with this result. This field is populated only if the input object to lint is of type google.iam.v1.Policy, which can comprise more than one binding. It is set to -1 if the result is not associated with any particular binding and only targets the policy as a whole, such as results about policy size violations. Corresponds to the JSON property bindingOrdinal

Returns:

  • (Fixnum)


593
594
595
# File 'generated/google/apis/iam_v1/classes.rb', line 593

def binding_ordinal
  @binding_ordinal
end

#debug_messageString

Human readable debug message associated with the issue. Corresponds to the JSON property debugMessage

Returns:

  • (String)


598
599
600
# File 'generated/google/apis/iam_v1/classes.rb', line 598

def debug_message
  @debug_message
end

#field_nameString

The name of the field for which this lint result is about. For nested messages, field_name consists of names of the embedded fields separated by period character. The top-level qualifier is the input object to lint in the request. For instance, if the lint request is on a google.iam.v1.Policy and this lint result is about a condition expression of one of the input policy bindings, the field would be populated as policy.bindings.condition.expression. This field does not identify the ordinality of the repetitive fields (for instance bindings in a policy). Corresponds to the JSON property fieldName

Returns:

  • (String)


611
612
613
# File 'generated/google/apis/iam_v1/classes.rb', line 611

def field_name
  @field_name
end

#levelString

The validation unit level. Corresponds to the JSON property level

Returns:

  • (String)


616
617
618
# File 'generated/google/apis/iam_v1/classes.rb', line 616

def level
  @level
end

#location_offsetFixnum

0-based character position of problematic construct within the object identified by field_name. Currently, this is populated only for condition expression. Corresponds to the JSON property locationOffset

Returns:

  • (Fixnum)


623
624
625
# File 'generated/google/apis/iam_v1/classes.rb', line 623

def location_offset
  @location_offset
end

#severityString

The validation unit severity. Corresponds to the JSON property severity

Returns:

  • (String)


628
629
630
# File 'generated/google/apis/iam_v1/classes.rb', line 628

def severity
  @severity
end

#validation_unit_nameString

The validation unit name, for instance “lintValidationUnits/ConditionComplexityCheck”. Corresponds to the JSON property validationUnitName

Returns:

  • (String)


634
635
636
# File 'generated/google/apis/iam_v1/classes.rb', line 634

def validation_unit_name
  @validation_unit_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



641
642
643
644
645
646
647
648
649
# File 'generated/google/apis/iam_v1/classes.rb', line 641

def update!(**args)
  @binding_ordinal = args[:binding_ordinal] if args.key?(:binding_ordinal)
  @debug_message = args[:debug_message] if args.key?(:debug_message)
  @field_name = args[:field_name] if args.key?(:field_name)
  @level = args[:level] if args.key?(:level)
  @location_offset = args[:location_offset] if args.key?(:location_offset)
  @severity = args[:severity] if args.key?(:severity)
  @validation_unit_name = args[:validation_unit_name] if args.key?(:validation_unit_name)
end