/* Copyright 2018 The TensorFlow Authors. All Rights Reserved.

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 class has been generated, DO NOT EDIT!

package org.tensorflow.op.data;

import java.util.Arrays;
import java.util.List;
import org.tensorflow.GraphOperation;
import org.tensorflow.Operand;
import org.tensorflow.Operation;
import org.tensorflow.OperationBuilder;
import org.tensorflow.Output;
import org.tensorflow.ndarray.Shape;
import org.tensorflow.op.Operands;
import org.tensorflow.op.RawOp;
import org.tensorflow.op.RawOpInputs;
import org.tensorflow.op.Scope;
import org.tensorflow.op.annotation.Endpoint;
import org.tensorflow.op.annotation.OpInputsMetadata;
import org.tensorflow.op.annotation.OpMetadata;
import org.tensorflow.proto.framework.DataType;
import org.tensorflow.types.TString;
import org.tensorflow.types.family.TType;

/**
 * Generates a MultiDeviceIterator resource from its provided string handle.
 */
@OpMetadata(
    opType = MultiDeviceIteratorFromStringHandle.OP_NAME,
    inputsClass = MultiDeviceIteratorFromStringHandle.Inputs.class
)
public final class MultiDeviceIteratorFromStringHandle extends RawOp implements Operand<TType> {
  /**
   * The name of this op, as known by TensorFlow core engine
   */
  public static final String OP_NAME = "MultiDeviceIteratorFromStringHandle";

  private Output<? extends TType> multiDeviceIterator;

  @SuppressWarnings("unchecked")
  public MultiDeviceIteratorFromStringHandle(Operation operation) {
    super(operation, OP_NAME);
    int outputIdx = 0;
    multiDeviceIterator = operation.output(outputIdx++);
  }

  /**
   * Factory method to create a class wrapping a new MultiDeviceIteratorFromStringHandle operation.
   *
   * @param scope current scope
   * @param stringHandle String representing the resource.
   * @param outputTypes The type list for the return values.
   * @param options carries optional attribute values
   * @return a new instance of MultiDeviceIteratorFromStringHandle
   */
  @Endpoint(
      describeByClass = true
  )
  public static MultiDeviceIteratorFromStringHandle create(Scope scope,
      Operand<TString> stringHandle, List<Class<? extends TType>> outputTypes, Options... options) {
    OperationBuilder opBuilder = scope.opBuilder(OP_NAME, "MultiDeviceIteratorFromStringHandle");
    opBuilder.addInput(stringHandle.asOutput());
    opBuilder.setAttr("output_types", Operands.toDataTypes(outputTypes));
    if (options != null) {
      for (Options opts : options) {
        if (opts.outputShapes != null) {
          Shape[] outputShapesArray = new Shape[opts.outputShapes.size()];
          for (int i = 0 ; i < outputShapesArray.length ; i++) {
            outputShapesArray[i] = opts.outputShapes.get(i);
          }
          opBuilder.setAttr("output_shapes", outputShapesArray);
        }
      }
    }
    return new MultiDeviceIteratorFromStringHandle(opBuilder.build());
  }

  /**
   * Sets the outputShapes option.
   *
   * @param outputShapes The list of shapes being produced.
   * @return this Options instance.
   */
  public static Options outputShapes(List<Shape> outputShapes) {
    return new Options().outputShapes(outputShapes);
  }

  /**
   * Sets the outputShapes option.
   *
   * @param outputShapes The list of shapes being produced.
   * @return this Options instance.
   */
  public static Options outputShapes(Shape... outputShapes) {
    return new Options().outputShapes(outputShapes);
  }

  /**
   * Gets multiDeviceIterator.
   * A MultiDeviceIterator resource.
   * @return multiDeviceIterator.
   */
  public Output<? extends TType> multiDeviceIterator() {
    return multiDeviceIterator;
  }

  @Override
  @SuppressWarnings("unchecked")
  public Output<TType> asOutput() {
    return (Output<TType>) multiDeviceIterator;
  }

  /**
   * Optional attributes for {@link org.tensorflow.op.data.MultiDeviceIteratorFromStringHandle}
   */
  public static class Options {
    private List<Shape> outputShapes;

    private Options() {
    }

    /**
     * Sets the outputShapes option.
     *
     * @param outputShapes The list of shapes being produced.
     * @return this Options instance.
     */
    public Options outputShapes(List<Shape> outputShapes) {
      this.outputShapes = outputShapes;
      return this;
    }

    /**
     * Sets the outputShapes option.
     *
     * @param outputShapes The list of shapes being produced.
     * @return this Options instance.
     */
    public Options outputShapes(Shape... outputShapes) {
      this.outputShapes = Arrays.asList(outputShapes);
      return this;
    }
  }

  @OpInputsMetadata(
      outputsClass = MultiDeviceIteratorFromStringHandle.class
  )
  public static class Inputs extends RawOpInputs<MultiDeviceIteratorFromStringHandle> {
    /**
     * String representing the resource.
     */
    public final Operand<TString> stringHandle;

    /**
     * The type list for the return values.
     */
    public final DataType[] outputTypes;

    /**
     * The list of shapes being produced.
     */
    public final Shape[] outputShapes;

    public Inputs(GraphOperation op) {
      super(new MultiDeviceIteratorFromStringHandle(op), op, Arrays.asList("output_types", "output_shapes"));
      int inputIndex = 0;
      stringHandle = (Operand<TString>) op.input(inputIndex++);
      outputTypes = op.attributes().getAttrTypeList("output_types");
      outputShapes = op.attributes().getAttrShapeList("output_shapes");
    }
  }
}
