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

Go to download
/*
 * 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;

/**
 * UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the
 * BackendService.
 *
 *  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 HostRule extends com.google.api.client.json.GenericJson {

  /**
   * An optional description of this resource. Provide this property when you create the resource.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String description;

  /**
   * The list of host patterns to match. They must be valid hostnames with optional port numbers in
   * the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first
   * character and must be followed in the pattern by either - or .. * based matching is not
   * supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless
   * field set to true.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List hosts;

  /**
   * The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches
   * the URL's host portion.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String pathMatcher;

  /**
   * An optional description of this resource. Provide this property when you create the resource.
   * @return value or {@code null} for none
   */
  public java.lang.String getDescription() {
    return description;
  }

  /**
   * An optional description of this resource. Provide this property when you create the resource.
   * @param description description or {@code null} for none
   */
  public HostRule setDescription(java.lang.String description) {
    this.description = description;
    return this;
  }

  /**
   * The list of host patterns to match. They must be valid hostnames with optional port numbers in
   * the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first
   * character and must be followed in the pattern by either - or .. * based matching is not
   * supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless
   * field set to true.
   * @return value or {@code null} for none
   */
  public java.util.List getHosts() {
    return hosts;
  }

  /**
   * The list of host patterns to match. They must be valid hostnames with optional port numbers in
   * the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first
   * character and must be followed in the pattern by either - or .. * based matching is not
   * supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless
   * field set to true.
   * @param hosts hosts or {@code null} for none
   */
  public HostRule setHosts(java.util.List hosts) {
    this.hosts = hosts;
    return this;
  }

  /**
   * The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches
   * the URL's host portion.
   * @return value or {@code null} for none
   */
  public java.lang.String getPathMatcher() {
    return pathMatcher;
  }

  /**
   * The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches
   * the URL's host portion.
   * @param pathMatcher pathMatcher or {@code null} for none
   */
  public HostRule setPathMatcher(java.lang.String pathMatcher) {
    this.pathMatcher = pathMatcher;
    return this;
  }

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

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

}