com.google.api.services.compute.model.RegionInstanceGroupsListInstancesRequest 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.compute.model;

/**
 * Model definition for RegionInstanceGroupsListInstancesRequest.
 *
 *  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 Compute Engine 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 RegionInstanceGroupsListInstancesRequest extends com.google.api.client.json.GenericJson {

  /**
   * Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default,
   * it lists all instances.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String instanceState;

  /**
   * Name of port user is interested in. It is optional. If it is set, only information about this
   * ports will be returned. If it is not set, all the named ports will be returned. Always lists
   * all instances.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String portName;

  /**
   * Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default,
   * it lists all instances.
   * @return value or {@code null} for none
   */
  public java.lang.String getInstanceState() {
    return instanceState;
  }

  /**
   * Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default,
   * it lists all instances.
   * @param instanceState instanceState or {@code null} for none
   */
  public RegionInstanceGroupsListInstancesRequest setInstanceState(java.lang.String instanceState) {
    this.instanceState = instanceState;
    return this;
  }

  /**
   * Name of port user is interested in. It is optional. If it is set, only information about this
   * ports will be returned. If it is not set, all the named ports will be returned. Always lists
   * all instances.
   * @return value or {@code null} for none
   */
  public java.lang.String getPortName() {
    return portName;
  }

  /**
   * Name of port user is interested in. It is optional. If it is set, only information about this
   * ports will be returned. If it is not set, all the named ports will be returned. Always lists
   * all instances.
   * @param portName portName or {@code null} for none
   */
  public RegionInstanceGroupsListInstancesRequest setPortName(java.lang.String portName) {
    this.portName = portName;
    return this;
  }

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

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

}