com.google.api.services.solar.v1.model.SolarPanel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-solar Show documentation
The 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.solar.v1.model;

/**
 * SolarPanel describes the position, orientation, and production of a single solar panel. See the
 * panel_height_meters, panel_width_meters, and panel_capacity_watts fields in SolarPotential for
 * information on the parameters of the panel.
 *
 *  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 Solar 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 SolarPanel extends com.google.api.client.json.GenericJson {

  /**
   * The centre of the panel.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private LatLng center;

  /**
   * The orientation of the panel.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String orientation;

  /**
   * Index in roof_segment_stats of the `RoofSegmentSizeAndSunshineStats` which corresponds to the
   * roof segment that this panel is placed on.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer segmentIndex;

  /**
   * How much sunlight energy this layout captures over the course of a year, in DC kWh.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float yearlyEnergyDcKwh;

  /**
   * The centre of the panel.
   * @return value or {@code null} for none
   */
  public LatLng getCenter() {
    return center;
  }

  /**
   * The centre of the panel.
   * @param center center or {@code null} for none
   */
  public SolarPanel setCenter(LatLng center) {
    this.center = center;
    return this;
  }

  /**
   * The orientation of the panel.
   * @return value or {@code null} for none
   */
  public java.lang.String getOrientation() {
    return orientation;
  }

  /**
   * The orientation of the panel.
   * @param orientation orientation or {@code null} for none
   */
  public SolarPanel setOrientation(java.lang.String orientation) {
    this.orientation = orientation;
    return this;
  }

  /**
   * Index in roof_segment_stats of the `RoofSegmentSizeAndSunshineStats` which corresponds to the
   * roof segment that this panel is placed on.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getSegmentIndex() {
    return segmentIndex;
  }

  /**
   * Index in roof_segment_stats of the `RoofSegmentSizeAndSunshineStats` which corresponds to the
   * roof segment that this panel is placed on.
   * @param segmentIndex segmentIndex or {@code null} for none
   */
  public SolarPanel setSegmentIndex(java.lang.Integer segmentIndex) {
    this.segmentIndex = segmentIndex;
    return this;
  }

  /**
   * How much sunlight energy this layout captures over the course of a year, in DC kWh.
   * @return value or {@code null} for none
   */
  public java.lang.Float getYearlyEnergyDcKwh() {
    return yearlyEnergyDcKwh;
  }

  /**
   * How much sunlight energy this layout captures over the course of a year, in DC kWh.
   * @param yearlyEnergyDcKwh yearlyEnergyDcKwh or {@code null} for none
   */
  public SolarPanel setYearlyEnergyDcKwh(java.lang.Float yearlyEnergyDcKwh) {
    this.yearlyEnergyDcKwh = yearlyEnergyDcKwh;
    return this;
  }

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

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

}