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

Go to download
/*
 * Copyright 2010 Google Inc.
 *
 * 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://code.google.com/p/google-apis-client-generator/
 * (build: 2017-02-15 17:18:02 UTC)
 * on 2017-08-07 at 18:49:37 UTC 
 * Modify at your own risk.
 */

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

/**
 * Message containing what to include in the cache key for a request for Cloud CDN.
 *
 *  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:
 * http://code.google.com/p/google-http-java-client/wiki/JSON
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class CacheKeyPolicy extends com.google.api.client.json.GenericJson {

  /**
   * If true, requests to different hosts will be cached separately.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean includeHost;

  /**
   * If true, http and https requests will be cached separately.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean includeProtocol;

  /**
   * If true, include query string parameters in the cache key according to query_string_whitelist
   * and query_string_blacklist. If neither is set, the entire query string will be included. If
   * false, the query string will be excluded from the cache key entirely.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean includeQueryString;

  /**
   * Names of query string parameters to exclude in cache keys. All other parameters will be
   * included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and
   * '=' will be percent encoded and not treated as delimiters.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List queryStringBlacklist;

  /**
   * Names of query string parameters to include in cache keys. All other parameters will be
   * excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and
   * '=' will be percent encoded and not treated as delimiters.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List queryStringWhitelist;

  /**
   * If true, requests to different hosts will be cached separately.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getIncludeHost() {
    return includeHost;
  }

  /**
   * If true, requests to different hosts will be cached separately.
   * @param includeHost includeHost or {@code null} for none
   */
  public CacheKeyPolicy setIncludeHost(java.lang.Boolean includeHost) {
    this.includeHost = includeHost;
    return this;
  }

  /**
   * If true, http and https requests will be cached separately.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getIncludeProtocol() {
    return includeProtocol;
  }

  /**
   * If true, http and https requests will be cached separately.
   * @param includeProtocol includeProtocol or {@code null} for none
   */
  public CacheKeyPolicy setIncludeProtocol(java.lang.Boolean includeProtocol) {
    this.includeProtocol = includeProtocol;
    return this;
  }

  /**
   * If true, include query string parameters in the cache key according to query_string_whitelist
   * and query_string_blacklist. If neither is set, the entire query string will be included. If
   * false, the query string will be excluded from the cache key entirely.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getIncludeQueryString() {
    return includeQueryString;
  }

  /**
   * If true, include query string parameters in the cache key according to query_string_whitelist
   * and query_string_blacklist. If neither is set, the entire query string will be included. If
   * false, the query string will be excluded from the cache key entirely.
   * @param includeQueryString includeQueryString or {@code null} for none
   */
  public CacheKeyPolicy setIncludeQueryString(java.lang.Boolean includeQueryString) {
    this.includeQueryString = includeQueryString;
    return this;
  }

  /**
   * Names of query string parameters to exclude in cache keys. All other parameters will be
   * included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and
   * '=' will be percent encoded and not treated as delimiters.
   * @return value or {@code null} for none
   */
  public java.util.List getQueryStringBlacklist() {
    return queryStringBlacklist;
  }

  /**
   * Names of query string parameters to exclude in cache keys. All other parameters will be
   * included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and
   * '=' will be percent encoded and not treated as delimiters.
   * @param queryStringBlacklist queryStringBlacklist or {@code null} for none
   */
  public CacheKeyPolicy setQueryStringBlacklist(java.util.List queryStringBlacklist) {
    this.queryStringBlacklist = queryStringBlacklist;
    return this;
  }

  /**
   * Names of query string parameters to include in cache keys. All other parameters will be
   * excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and
   * '=' will be percent encoded and not treated as delimiters.
   * @return value or {@code null} for none
   */
  public java.util.List getQueryStringWhitelist() {
    return queryStringWhitelist;
  }

  /**
   * Names of query string parameters to include in cache keys. All other parameters will be
   * excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and
   * '=' will be percent encoded and not treated as delimiters.
   * @param queryStringWhitelist queryStringWhitelist or {@code null} for none
   */
  public CacheKeyPolicy setQueryStringWhitelist(java.util.List queryStringWhitelist) {
    this.queryStringWhitelist = queryStringWhitelist;
    return this;
  }

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

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

}