com.google.api.services.compute.model.RouterNatRule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation
There is a newer version: v1-rev20250107-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.compute.model;

/**
 * Model definition for RouterNatRule.
 *
 *  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 Compute Engine API. 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 RouterNatRule extends com.google.api.client.json.GenericJson {

  /**
   * The action to be enforced for traffic that matches this rule.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private RouterNatRuleAction action;

  /**
   * An optional description of this rule.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String description;

  /**
   * CEL expression that specifies the match condition that egress traffic from a VM is evaluated
   * against. If it evaluates to true, the corresponding ?action? is enforced.
   *
   * The following examples are valid match expressions:
   *
   * "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')"
   *
   * "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'"
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String match;

  /**
   * An integer indicating the priority of a rule in the list. The priority must be a positive value
   * between 0 and 65000. The priority must be unique among rules within a NAT.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Long priority;

  /**
   * The action to be enforced for traffic that matches this rule.
   * @return value or {@code null} for none
   */
  public RouterNatRuleAction getAction() {
    return action;
  }

  /**
   * The action to be enforced for traffic that matches this rule.
   * @param action action or {@code null} for none
   */
  public RouterNatRule setAction(RouterNatRuleAction action) {
    this.action = action;
    return this;
  }

  /**
   * An optional description of this rule.
   * @return value or {@code null} for none
   */
  public java.lang.String getDescription() {
    return description;
  }

  /**
   * An optional description of this rule.
   * @param description description or {@code null} for none
   */
  public RouterNatRule setDescription(java.lang.String description) {
    this.description = description;
    return this;
  }

  /**
   * CEL expression that specifies the match condition that egress traffic from a VM is evaluated
   * against. If it evaluates to true, the corresponding ?action? is enforced.
   *
   * The following examples are valid match expressions:
   *
   * "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')"
   *
   * "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'"
   * @return value or {@code null} for none
   */
  public java.lang.String getMatch() {
    return match;
  }

  /**
   * CEL expression that specifies the match condition that egress traffic from a VM is evaluated
   * against. If it evaluates to true, the corresponding ?action? is enforced.
   *
   * The following examples are valid match expressions:
   *
   * "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')"
   *
   * "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'"
   * @param match match or {@code null} for none
   */
  public RouterNatRule setMatch(java.lang.String match) {
    this.match = match;
    return this;
  }

  /**
   * An integer indicating the priority of a rule in the list. The priority must be a positive value
   * between 0 and 65000. The priority must be unique among rules within a NAT.
   * @return value or {@code null} for none
   */
  public java.lang.Long getPriority() {
    return priority;
  }

  /**
   * An integer indicating the priority of a rule in the list. The priority must be a positive value
   * between 0 and 65000. The priority must be unique among rules within a NAT.
   * @param priority priority or {@code null} for none
   */
  public RouterNatRule setPriority(java.lang.Long priority) {
    this.priority = priority;
    return this;
  }

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

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

}