com.google.api.services.servicecontrol.v2.model.Api 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.servicecontrol.v2.model;

/**
 * This message defines attributes associated with API operations, such as a network API request.
 * The terminology is based on the conventions used by Google APIs, Istio, and OpenAPI.
 *
 *  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 Control 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 Api extends com.google.api.client.json.GenericJson {

  /**
   * The API operation name. For gRPC requests, it is the fully qualified API method name, such as
   * "google.pubsub.v1.Publisher.Publish". For OpenAPI requests, it is the `operationId`, such as
   * "getPet".
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String operation;

  /**
   * The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String protocol;

  /**
   * The API service name. It is a logical identifier for a networked API, such as
   * "pubsub.googleapis.com". The naming syntax depends on the API management system being used for
   * handling the request.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String service;

  /**
   * The API version associated with the API operation above, such as "v1" or "v1alpha1".
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String version;

  /**
   * The API operation name. For gRPC requests, it is the fully qualified API method name, such as
   * "google.pubsub.v1.Publisher.Publish". For OpenAPI requests, it is the `operationId`, such as
   * "getPet".
   * @return value or {@code null} for none
   */
  public java.lang.String getOperation() {
    return operation;
  }

  /**
   * The API operation name. For gRPC requests, it is the fully qualified API method name, such as
   * "google.pubsub.v1.Publisher.Publish". For OpenAPI requests, it is the `operationId`, such as
   * "getPet".
   * @param operation operation or {@code null} for none
   */
  public Api setOperation(java.lang.String operation) {
    this.operation = operation;
    return this;
  }

  /**
   * The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".
   * @return value or {@code null} for none
   */
  public java.lang.String getProtocol() {
    return protocol;
  }

  /**
   * The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".
   * @param protocol protocol or {@code null} for none
   */
  public Api setProtocol(java.lang.String protocol) {
    this.protocol = protocol;
    return this;
  }

  /**
   * The API service name. It is a logical identifier for a networked API, such as
   * "pubsub.googleapis.com". The naming syntax depends on the API management system being used for
   * handling the request.
   * @return value or {@code null} for none
   */
  public java.lang.String getService() {
    return service;
  }

  /**
   * The API service name. It is a logical identifier for a networked API, such as
   * "pubsub.googleapis.com". The naming syntax depends on the API management system being used for
   * handling the request.
   * @param service service or {@code null} for none
   */
  public Api setService(java.lang.String service) {
    this.service = service;
    return this;
  }

  /**
   * The API version associated with the API operation above, such as "v1" or "v1alpha1".
   * @return value or {@code null} for none
   */
  public java.lang.String getVersion() {
    return version;
  }

  /**
   * The API version associated with the API operation above, such as "v1" or "v1alpha1".
   * @param version version or {@code null} for none
   */
  public Api setVersion(java.lang.String version) {
    this.version = version;
    return this;
  }

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

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

}