com.google.api.services.servicemanagement.model.OperationInfo 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-rev20241106-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.servicemanagement.model;

/**
 * A message representing the message types used by a long-running operation. Example: rpc
 * Export(ExportRequest) returns (google.longrunning.Operation) { option
 * (google.longrunning.operation_info) = { response_type: "ExportResponse" metadata_type:
 * "ExportMetadata" }; }
 *
 *  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 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 OperationInfo extends com.google.api.client.json.GenericJson {

  /**
   * Required. The message name of the metadata type for this long-running operation. If the
   * response is in a different package from the rpc, a fully-qualified message name must be used
   * (e.g. `google.protobuf.Struct`). Note: Altering this value constitutes a breaking change.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String metadataType;

  /**
   * Required. The message name of the primary return type for this long-running operation. This
   * type will be used to deserialize the LRO's response. If the response is in a different package
   * from the rpc, a fully-qualified message name must be used (e.g. `google.protobuf.Struct`).
   * Note: Altering this value constitutes a breaking change.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String responseType;

  /**
   * Required. The message name of the metadata type for this long-running operation. If the
   * response is in a different package from the rpc, a fully-qualified message name must be used
   * (e.g. `google.protobuf.Struct`). Note: Altering this value constitutes a breaking change.
   * @return value or {@code null} for none
   */
  public java.lang.String getMetadataType() {
    return metadataType;
  }

  /**
   * Required. The message name of the metadata type for this long-running operation. If the
   * response is in a different package from the rpc, a fully-qualified message name must be used
   * (e.g. `google.protobuf.Struct`). Note: Altering this value constitutes a breaking change.
   * @param metadataType metadataType or {@code null} for none
   */
  public OperationInfo setMetadataType(java.lang.String metadataType) {
    this.metadataType = metadataType;
    return this;
  }

  /**
   * Required. The message name of the primary return type for this long-running operation. This
   * type will be used to deserialize the LRO's response. If the response is in a different package
   * from the rpc, a fully-qualified message name must be used (e.g. `google.protobuf.Struct`).
   * Note: Altering this value constitutes a breaking change.
   * @return value or {@code null} for none
   */
  public java.lang.String getResponseType() {
    return responseType;
  }

  /**
   * Required. The message name of the primary return type for this long-running operation. This
   * type will be used to deserialize the LRO's response. If the response is in a different package
   * from the rpc, a fully-qualified message name must be used (e.g. `google.protobuf.Struct`).
   * Note: Altering this value constitutes a breaking change.
   * @param responseType responseType or {@code null} for none
   */
  public OperationInfo setResponseType(java.lang.String responseType) {
    this.responseType = responseType;
    return this;
  }

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

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

}