com.google.api.services.serviceusage.v1.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-serviceusage Show documentation
There is a newer version: v1-rev20241025-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.serviceusage.v1.model;

/**
 * `Endpoint` describes a network address of a service that serves a set of APIs. It is commonly
 * known as a service endpoint. A service may expose any number of service endpoints, and all
 * service endpoints share the same service definition, such as quota limits and monitoring metrics.
 * Example: type: google.api.Service name: library-example.googleapis.com endpoints: # Declares
 * network address `https://library-example.googleapis.com` # for service `library-
 * example.googleapis.com`. The `https` scheme # is implicit for all service endpoints. Other
 * schemes may be # supported in the future. - name: library-example.googleapis.com allow_cors:
 * false - name: content-staging-library-example.googleapis.com # Allows HTTP OPTIONS calls to be
 * passed to the API frontend, for it # to decide whether the subsequent cross-origin request is
 * allowed # to proceed. 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 Service Usage 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 {

  /**
   * Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and
   * will be provisioned in the GCP stack for the Regional Endpoints.
   * 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 canonical name of this endpoint.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * The specification of an Internet routable address of API frontend that will handle requests to
   * this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid
   * IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or
   * "myservice.appspot.com".
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String target;

  /**
   * Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and
   * will be provisioned in the GCP stack for the Regional Endpoints.
   * @return value or {@code null} for none
   */
  public java.util.List getAliases() {
    return aliases;
  }

  /**
   * Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and
   * will be provisioned in the GCP stack for the Regional Endpoints.
   * @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 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;
  }

  /**
   * The specification of an Internet routable address of API frontend that will handle requests to
   * this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid
   * IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or
   * "myservice.appspot.com".
   * @return value or {@code null} for none
   */
  public java.lang.String getTarget() {
    return target;
  }

  /**
   * The specification of an Internet routable address of API frontend that will handle requests to
   * this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid
   * IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or
   * "myservice.appspot.com".
   * @param target target or {@code null} for none
   */
  public Endpoint setTarget(java.lang.String target) {
    this.target = target;
    return this;
  }

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

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

}