com.google.api.services.content.model.DeliveryAreaPostalCodeRange Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-content Show documentation
There is a newer version: v2.1-rev20241217-2.0.0
Show newest version
/*
 * 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.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.content.model;

/**
 * A range of postal codes that defines the delivery area. Only set firstPostalCode when specifying
 * a single postal code.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Content API for Shopping. For a detailed explanation
 * see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class DeliveryAreaPostalCodeRange extends com.google.api.client.json.GenericJson {

  /**
   * Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of
   * the range defining the area. Examples values: "94108", "9410*", "9*".
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String firstPostalCode;

  /**
   * A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range
   * defining the area (for example [070* - 078*] results in the range [07000 - 07899]). It must
   * have the same length as firstPostalCode: if firstPostalCode is a postal code then
   * lastPostalCode must be a postal code too; if firstPostalCode is a pattern then lastPostalCode
   * must be a pattern with the same prefix length. Ignored if not set, then the area is defined as
   * being all the postal codes matching firstPostalCode.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String lastPostalCode;

  /**
   * Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of
   * the range defining the area. Examples values: "94108", "9410*", "9*".
   * @return value or {@code null} for none
   */
  public java.lang.String getFirstPostalCode() {
    return firstPostalCode;
  }

  /**
   * Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of
   * the range defining the area. Examples values: "94108", "9410*", "9*".
   * @param firstPostalCode firstPostalCode or {@code null} for none
   */
  public DeliveryAreaPostalCodeRange setFirstPostalCode(java.lang.String firstPostalCode) {
    this.firstPostalCode = firstPostalCode;
    return this;
  }

  /**
   * A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range
   * defining the area (for example [070* - 078*] results in the range [07000 - 07899]). It must
   * have the same length as firstPostalCode: if firstPostalCode is a postal code then
   * lastPostalCode must be a postal code too; if firstPostalCode is a pattern then lastPostalCode
   * must be a pattern with the same prefix length. Ignored if not set, then the area is defined as
   * being all the postal codes matching firstPostalCode.
   * @return value or {@code null} for none
   */
  public java.lang.String getLastPostalCode() {
    return lastPostalCode;
  }

  /**
   * A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range
   * defining the area (for example [070* - 078*] results in the range [07000 - 07899]). It must
   * have the same length as firstPostalCode: if firstPostalCode is a postal code then
   * lastPostalCode must be a postal code too; if firstPostalCode is a pattern then lastPostalCode
   * must be a pattern with the same prefix length. Ignored if not set, then the area is defined as
   * being all the postal codes matching firstPostalCode.
   * @param lastPostalCode lastPostalCode or {@code null} for none
   */
  public DeliveryAreaPostalCodeRange setLastPostalCode(java.lang.String lastPostalCode) {
    this.lastPostalCode = lastPostalCode;
    return this;
  }

  @Override
  public DeliveryAreaPostalCodeRange set(String fieldName, Object value) {
    return (DeliveryAreaPostalCodeRange) super.set(fieldName, value);
  }

  @Override
  public DeliveryAreaPostalCodeRange clone() {
    return (DeliveryAreaPostalCodeRange) super.clone();
  }

}