com.google.api.services.spectrum.model.PawsNotifySpectrumUseRequest Maven / Gradle / Ivy
/*
* Copyright 2010 Google Inc.
*
* 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/google/apis-client-generator/
* (build: 2016-05-04 15:59:39 UTC)
* on 2016-05-18 at 06:28:13 UTC
* Modify at your own risk.
*/
package com.google.api.services.spectrum.model;
/**
* The spectrum-use notification message which must contain the geolocation of the Device and
* parameters required by the regulatory domain.
*
* 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 Google Spectrum Database 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 PawsNotifySpectrumUseRequest extends com.google.api.client.json.GenericJson {
/**
* Device descriptor information is required in the spectrum-use notification message.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private DeviceDescriptor deviceDesc;
/**
* The geolocation of the master device (the device that is sending the spectrum-use notification)
* to the database is required in the spectrum-use notification message.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GeoLocation location;
/**
* A spectrum list is required in the spectrum-use notification. The list specifies the spectrum
* that the device expects to use, which includes frequency ranges and maximum power levels. The
* list may be empty if the device decides not to use any of spectrum. For consistency, the
* psdBandwidthHz value should match that from one of the spectrum elements in the corresponding
* available spectrum response previously sent to the device by the database. Note that maximum
* power levels in the spectrum element must be expressed as power spectral density over the
* specified psdBandwidthHz value. The actual bandwidth to be used (as computed from the start and
* stop frequencies) may be different from the psdBandwidthHz value. As an example, when
* regulatory rules express maximum power spectral density in terms of maximum power over any 100
* kHz band, then the psdBandwidthHz value should be set to 100 kHz, even though the actual
* bandwidth used can be 20 kHz.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List spectra;
/**
* The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...).
*
* Required field.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String type;
/**
* The PAWS version. Must be exactly 1.0.
*
* Required field.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String version;
/**
* Device descriptor information is required in the spectrum-use notification message.
* @return value or {@code null} for none
*/
public DeviceDescriptor getDeviceDesc() {
return deviceDesc;
}
/**
* Device descriptor information is required in the spectrum-use notification message.
* @param deviceDesc deviceDesc or {@code null} for none
*/
public PawsNotifySpectrumUseRequest setDeviceDesc(DeviceDescriptor deviceDesc) {
this.deviceDesc = deviceDesc;
return this;
}
/**
* The geolocation of the master device (the device that is sending the spectrum-use notification)
* to the database is required in the spectrum-use notification message.
* @return value or {@code null} for none
*/
public GeoLocation getLocation() {
return location;
}
/**
* The geolocation of the master device (the device that is sending the spectrum-use notification)
* to the database is required in the spectrum-use notification message.
* @param location location or {@code null} for none
*/
public PawsNotifySpectrumUseRequest setLocation(GeoLocation location) {
this.location = location;
return this;
}
/**
* A spectrum list is required in the spectrum-use notification. The list specifies the spectrum
* that the device expects to use, which includes frequency ranges and maximum power levels. The
* list may be empty if the device decides not to use any of spectrum. For consistency, the
* psdBandwidthHz value should match that from one of the spectrum elements in the corresponding
* available spectrum response previously sent to the device by the database. Note that maximum
* power levels in the spectrum element must be expressed as power spectral density over the
* specified psdBandwidthHz value. The actual bandwidth to be used (as computed from the start and
* stop frequencies) may be different from the psdBandwidthHz value. As an example, when
* regulatory rules express maximum power spectral density in terms of maximum power over any 100
* kHz band, then the psdBandwidthHz value should be set to 100 kHz, even though the actual
* bandwidth used can be 20 kHz.
* @return value or {@code null} for none
*/
public java.util.List getSpectra() {
return spectra;
}
/**
* A spectrum list is required in the spectrum-use notification. The list specifies the spectrum
* that the device expects to use, which includes frequency ranges and maximum power levels. The
* list may be empty if the device decides not to use any of spectrum. For consistency, the
* psdBandwidthHz value should match that from one of the spectrum elements in the corresponding
* available spectrum response previously sent to the device by the database. Note that maximum
* power levels in the spectrum element must be expressed as power spectral density over the
* specified psdBandwidthHz value. The actual bandwidth to be used (as computed from the start and
* stop frequencies) may be different from the psdBandwidthHz value. As an example, when
* regulatory rules express maximum power spectral density in terms of maximum power over any 100
* kHz band, then the psdBandwidthHz value should be set to 100 kHz, even though the actual
* bandwidth used can be 20 kHz.
* @param spectra spectra or {@code null} for none
*/
public PawsNotifySpectrumUseRequest setSpectra(java.util.List spectra) {
this.spectra = spectra;
return this;
}
/**
* The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...).
*
* Required field.
* @return value or {@code null} for none
*/
public java.lang.String getType() {
return type;
}
/**
* The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...).
*
* Required field.
* @param type type or {@code null} for none
*/
public PawsNotifySpectrumUseRequest setType(java.lang.String type) {
this.type = type;
return this;
}
/**
* The PAWS version. Must be exactly 1.0.
*
* Required field.
* @return value or {@code null} for none
*/
public java.lang.String getVersion() {
return version;
}
/**
* The PAWS version. Must be exactly 1.0.
*
* Required field.
* @param version version or {@code null} for none
*/
public PawsNotifySpectrumUseRequest setVersion(java.lang.String version) {
this.version = version;
return this;
}
@Override
public PawsNotifySpectrumUseRequest set(String fieldName, Object value) {
return (PawsNotifySpectrumUseRequest) super.set(fieldName, value);
}
@Override
public PawsNotifySpectrumUseRequest clone() {
return (PawsNotifySpectrumUseRequest) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy