com.google.api.services.serviceusage.v1.model.MethodSettings 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;

/**
 * Describes the generator configuration for a method.
 *
 *  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 MethodSettings extends com.google.api.client.json.GenericJson {

  /**
   * List of top-level fields of the request message, that should be automatically populated by the
   * client libraries based on their (google.api.field_info).format. Currently supported format:
   * UUID4. Example of a YAML configuration: publishing: method_settings: - selector:
   * google.example.v1.ExampleService.CreateExample auto_populated_fields: - request_id
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List autoPopulatedFields;

  /**
   * Describes settings to use for long-running operations when generating API methods for RPCs.
   * Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a
   * YAML configuration:: publishing: method_settings: - selector:
   * google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: 60s # 1 minute
   * poll_delay_multiplier: 1.5 max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90
   * minutes
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private LongRunning longRunning;

  /**
   * The fully qualified name of the method, for which the options below apply. This is used to find
   * the method to apply the options. Example: publishing: method_settings: - selector:
   * google.storage.control.v2.StorageControl.CreateFolder # method settings for CreateFolder...
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String selector;

  /**
   * List of top-level fields of the request message, that should be automatically populated by the
   * client libraries based on their (google.api.field_info).format. Currently supported format:
   * UUID4. Example of a YAML configuration: publishing: method_settings: - selector:
   * google.example.v1.ExampleService.CreateExample auto_populated_fields: - request_id
   * @return value or {@code null} for none
   */
  public java.util.List getAutoPopulatedFields() {
    return autoPopulatedFields;
  }

  /**
   * List of top-level fields of the request message, that should be automatically populated by the
   * client libraries based on their (google.api.field_info).format. Currently supported format:
   * UUID4. Example of a YAML configuration: publishing: method_settings: - selector:
   * google.example.v1.ExampleService.CreateExample auto_populated_fields: - request_id
   * @param autoPopulatedFields autoPopulatedFields or {@code null} for none
   */
  public MethodSettings setAutoPopulatedFields(java.util.List autoPopulatedFields) {
    this.autoPopulatedFields = autoPopulatedFields;
    return this;
  }

  /**
   * Describes settings to use for long-running operations when generating API methods for RPCs.
   * Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a
   * YAML configuration:: publishing: method_settings: - selector:
   * google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: 60s # 1 minute
   * poll_delay_multiplier: 1.5 max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90
   * minutes
   * @return value or {@code null} for none
   */
  public LongRunning getLongRunning() {
    return longRunning;
  }

  /**
   * Describes settings to use for long-running operations when generating API methods for RPCs.
   * Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a
   * YAML configuration:: publishing: method_settings: - selector:
   * google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: 60s # 1 minute
   * poll_delay_multiplier: 1.5 max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90
   * minutes
   * @param longRunning longRunning or {@code null} for none
   */
  public MethodSettings setLongRunning(LongRunning longRunning) {
    this.longRunning = longRunning;
    return this;
  }

  /**
   * The fully qualified name of the method, for which the options below apply. This is used to find
   * the method to apply the options. Example: publishing: method_settings: - selector:
   * google.storage.control.v2.StorageControl.CreateFolder # method settings for CreateFolder...
   * @return value or {@code null} for none
   */
  public java.lang.String getSelector() {
    return selector;
  }

  /**
   * The fully qualified name of the method, for which the options below apply. This is used to find
   * the method to apply the options. Example: publishing: method_settings: - selector:
   * google.storage.control.v2.StorageControl.CreateFolder # method settings for CreateFolder...
   * @param selector selector or {@code null} for none
   */
  public MethodSettings setSelector(java.lang.String selector) {
    this.selector = selector;
    return this;
  }

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

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

}