com.google.api.services.servicemanagement.model.Endpoint Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-servicemanagement Show documentation
There is a newer version: v1-rev20241202-2.0.0
Show newest version
/*
 * 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://github.com/google/apis-client-generator/
 * (build: 2016-10-17 16:43:55 UTC)
 * on 2016-10-25 at 06:53:30 UTC 
 * Modify at your own risk.
 */

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

/**
 * `Endpoint` describes a network endpoint that serves a set of APIs. A service may expose any
 * number of endpoints, and all endpoints share the same service configuration, such as quota
 * configuration and monitoring configuration.
 *
 * Example service configuration:
 *
 *     name: library-example.googleapis.com     endpoints:       # Below entry makes
 * 'google.example.library.v1.Library'       # API be served from endpoint address library-
 * example.googleapis.com.       # It also allows HTTP OPTIONS calls to be passed to the backend,
 * for       # it to decide whether the subsequent cross-origin request is       # allowed to
 * proceed.     - name: library-example.googleapis.com       apis: google.example.library.v1.Library
 * allow_cors: true       # Below entry makes 'google.example.library.v1.Library'       # API be
 * served from endpoint address       # google.example.library-example.v1.LibraryManager.     -
 * name: library-manager.googleapis.com       apis: google.example.library.v1.LibraryManager       #
 * BNS address for a borg job. Can specify a task by appending       # "/taskId" (e.g. "/0") to the
 * job spec.
 *
 * Example OpenAPI extension for endpoint with allow_cors set to true:
 *
 *     {       "swagger": "2.0",       "info": {         "description": "A simple..."       },
 * "host": "MY_PROJECT_ID.appspot.com",       "x-google-endpoints": [{         "name":
 * "MY_PROJECT_ID.appspot.com",         "allow_cors": "true"       }]     }
 *
 *  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 Google Service Management 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 Endpoint extends com.google.api.client.json.GenericJson {

  /**
   * DEPRECATED: This field is no longer supported. Instead of using aliases, please specify
   * multiple google.api.Endpoint for each of the intented alias.
   *
   * Additional names that this endpoint will be hosted on.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List aliases;

  /**
   * Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain
   * traffic, would allow the backends served from this endpoint to receive and respond to HTTP
   * OPTIONS requests. The response will be used by the browser to determine whether the subsequent
   * cross-origin request is allowed to proceed.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean allowCors;

  /**
   * The list of APIs served by this endpoint.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List apis;

  /**
   * The list of features enabled on this endpoint.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List features;

  /**
   * The canonical name of this endpoint.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * DEPRECATED: This field is no longer supported. Instead of using aliases, please specify
   * multiple google.api.Endpoint for each of the intented alias.
   *
   * Additional names that this endpoint will be hosted on.
   * @return value or {@code null} for none
   */
  public java.util.List getAliases() {
    return aliases;
  }

  /**
   * DEPRECATED: This field is no longer supported. Instead of using aliases, please specify
   * multiple google.api.Endpoint for each of the intented alias.
   *
   * Additional names that this endpoint will be hosted on.
   * @param aliases aliases or {@code null} for none
   */
  public Endpoint setAliases(java.util.List aliases) {
    this.aliases = aliases;
    return this;
  }

  /**
   * Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain
   * traffic, would allow the backends served from this endpoint to receive and respond to HTTP
   * OPTIONS requests. The response will be used by the browser to determine whether the subsequent
   * cross-origin request is allowed to proceed.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getAllowCors() {
    return allowCors;
  }

  /**
   * Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain
   * traffic, would allow the backends served from this endpoint to receive and respond to HTTP
   * OPTIONS requests. The response will be used by the browser to determine whether the subsequent
   * cross-origin request is allowed to proceed.
   * @param allowCors allowCors or {@code null} for none
   */
  public Endpoint setAllowCors(java.lang.Boolean allowCors) {
    this.allowCors = allowCors;
    return this;
  }

  /**
   * The list of APIs served by this endpoint.
   * @return value or {@code null} for none
   */
  public java.util.List getApis() {
    return apis;
  }

  /**
   * The list of APIs served by this endpoint.
   * @param apis apis or {@code null} for none
   */
  public Endpoint setApis(java.util.List apis) {
    this.apis = apis;
    return this;
  }

  /**
   * The list of features enabled on this endpoint.
   * @return value or {@code null} for none
   */
  public java.util.List getFeatures() {
    return features;
  }

  /**
   * The list of features enabled on this endpoint.
   * @param features features or {@code null} for none
   */
  public Endpoint setFeatures(java.util.List features) {
    this.features = features;
    return this;
  }

  /**
   * The canonical name of this endpoint.
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * The canonical name of this endpoint.
   * @param name name or {@code null} for none
   */
  public Endpoint setName(java.lang.String name) {
    this.name = name;
    return this;
  }

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

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

}