class Azure::CognitiveServices::LocalSearch::V1_0::Models::PostalAddress

Defines a postal address.

Attributes

_type[RW]
address_country[RW]

@return [String] The country/region where the street address is located. This could be the two-letter ISO code. For example, US, or the full name, United States.

address_locality[RW]

@return [String] The city where the street address is located. For example, Seattle.

address_region[RW]

@return [String] The state or province code where the street address is located. This could be the two-letter code. For example, WA, or the full name , Washington.

address_region_abbreviation[RW]

@return [String] Region Abbreviation. For example, WA.

address_subregion[RW]

@return [String]

country_iso[RW]

@return [String] The two letter ISO code of this country. For example, US.

formatting_rule_id[RW]

@return [String]

house_number[RW]

@return [String]

neighborhood[RW]

@return [String] The neighborhood where the street address is located. For example, Westlake.

post_office_box_number[RW]

@return [String]

postal_code[RW]

@return [String] The zip code or postal code where the street address is located. For example, 98052.

street_address[RW]

@return [String]

street_name[RW]

@return [String]

text[RW]

@return [String] The complete address. For example, 2100 Westlake Ave N, Bellevue, WA 98052.

Private Class Methods

mapper() click to toggle source

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

# File lib/1.0/generated/azure_cognitiveservices_localsearch/models/postal_address.rb, line 78
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'PostalAddress',
    type: {
      name: 'Composite',
      class_name: 'PostalAddress',
      model_properties: {
        _type: {
          client_side_validation: true,
          required: true,
          serialized_name: '_type',
          type: {
            name: 'String'
          }
        },
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        read_link: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'readLink',
          type: {
            name: 'String'
          }
        },
        web_search_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'webSearchUrl',
          type: {
            name: 'String'
          }
        },
        potential_action: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'potentialAction',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ActionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Action'
                }
            }
          }
        },
        immediate_action: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'immediateAction',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ActionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Action'
                }
            }
          }
        },
        preferred_clickthrough_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'preferredClickthroughUrl',
          type: {
            name: 'String'
          }
        },
        adaptive_card: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'adaptiveCard',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'url',
          type: {
            name: 'String'
          }
        },
        entity_presentation_info: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'entityPresentationInfo',
          type: {
            name: 'Composite',
            polymorphic_discriminator: '_type',
            uber_parent: 'EntitiesEntityPresentationInfo',
            class_name: 'EntitiesEntityPresentationInfo'
          }
        },
        street_address: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'streetAddress',
          type: {
            name: 'String'
          }
        },
        address_locality: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'addressLocality',
          type: {
            name: 'String'
          }
        },
        address_subregion: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'addressSubregion',
          type: {
            name: 'String'
          }
        },
        address_region: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'addressRegion',
          type: {
            name: 'String'
          }
        },
        postal_code: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'postalCode',
          type: {
            name: 'String'
          }
        },
        post_office_box_number: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'postOfficeBoxNumber',
          type: {
            name: 'String'
          }
        },
        address_country: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'addressCountry',
          type: {
            name: 'String'
          }
        },
        country_iso: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'countryIso',
          type: {
            name: 'String'
          }
        },
        neighborhood: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'neighborhood',
          type: {
            name: 'String'
          }
        },
        address_region_abbreviation: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'addressRegionAbbreviation',
          type: {
            name: 'String'
          }
        },
        text: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'text',
          type: {
            name: 'String'
          }
        },
        house_number: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'houseNumber',
          type: {
            name: 'String'
          }
        },
        street_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'streetName',
          type: {
            name: 'String'
          }
        },
        formatting_rule_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'formattingRuleId',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end
new() click to toggle source
# File lib/1.0/generated/azure_cognitiveservices_localsearch/models/postal_address.rb, line 16
def initialize
  @_type = "PostalAddress"
end