// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

syntax = "proto3";

package google.maps.addressvalidation.v1;

option cc_enable_arenas = true;
option csharp_namespace = "Google.Maps.AddressValidation.V1";
option go_package = "google.golang.org/genproto/googleapis/maps/addressvalidation/v1;addressvalidation";
option java_multiple_files = true;
option java_outer_classname = "MetadataProto";
option java_package = "com.google.maps.addressvalidation.v1";
option objc_class_prefix = "GMPAVV1";
option php_namespace = "Google\\Maps\\AddressValidation\\V1";
option ruby_package = "Google::Maps::AddressValidation::V1";

// The metadata for the address.
message AddressMetadata {
  // Indicates that this address is a high-rise building.
  // If unset, indicates that the value is unknown.
  //
  // DEPRECATED: Please use
  // [`address_record_type`](google.maps.addressvalidation.v1.ValidationResult.usps_data.address_record_type)
  // instead. This field will be removed with the GA release.
  optional bool highrise = 1 [deprecated = true];

  // Indicates that this is the address of a business.
  // If unset, indicates that the value is unknown.
  optional bool business = 2;

  // Indicates that the address of a PO box.
  // If unset, indicates that the value is unknown.
  optional bool po_box = 3;

  // Indicates that the address is of a multi-family building.
  // If unset, indicates that the value is unknown.
  //
  // DEPRECATED: this field will be removed with the GA release.
  optional bool multi_family = 4 [deprecated = true];

  // Indicates that this is the address of a residence.
  // If unset, indicates that the value is unknown.
  optional bool residential = 6;
}