geographic_region.proto

// Copyright 2020-2024 SIX AFTER, INC (SIX AFTER)
//
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: SIX AFTER, INC (SIX AFTER)
//
// 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 sixafter.types;

option go_package="github.com/sixafter/types;types";
option cc_enable_arenas = true;
option java_package = "com.sixafter.types";
option java_multiple_files = true;
option java_outer_classname = "GeographicRegionProto";
option objc_class_prefix = "TPB";
option csharp_namespace = "SixAfter.Types.WellKnownTypes";

// The `GeographicRegion` message represents a region as defined by the ISO 3166-2 standard.
// ISO 3166-2 defines codes for identifying the principal subdivisions (e.g., states or provinces)
// of countries coded in ISO 3166-1. This message can be used in applications requiring
// geographic or administrative classification.
message GeographicRegion {

  // The commonly used name of the region.
  // Example: "Texas".
  string name = 1;

  // The formal or official name of the region.
  // Example: "State of Texas".
  string formal_name = 2;

  // The numeric code for the region as defined in the ISO 3166-2 standard.
  // This code is often used in databases or systems where numeric identifiers
  // are preferred for regional classification.
  // Example: 48 (numeric code for Texas in the United States, if applicable).
  uint32 numeric_code = 3;

  // The country to which the region belongs.
  // This should use the ISO 3166-1 alpha-2 code of the country.
  // Example: "US" for the United States.
  string country = 4;

  // The country subdivision code for the region.
  // This should use the ISO 3166-2 code for the specific subdivision.
  // Example: "US-TX" for Texas in the United States.
  string country_subdivision = 5;
}