com.google.api.services.spectrum.model.PawsGetSpectrumRequest 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 request message for the available spectrum query protocol which must include the device's
* geolocation.
*
* 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 PawsGetSpectrumRequest extends com.google.api.client.json.GenericJson {
/**
* Depending on device type and regulatory domain, the characteristics of the antenna may be
* required.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private AntennaCharacteristics antenna;
/**
* The master device may include its device capabilities to limit the available-spectrum response
* to the spectrum that is compatible with its capabilities. The database should not return
* spectrum that is incompatible with the specified capabilities.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private DeviceCapabilities capabilities;
/**
* When the available spectrum request is made on behalf of a specific device (a master or slave
* device), device descriptor information for that device is required (in such cases, the
* requestType parameter must be empty). When a requestType value is specified, device descriptor
* information may be optional or required according to the rules of the applicable regulatory
* domain.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private DeviceDescriptor deviceDesc;
/**
* The geolocation of the master device (a device with geolocation capability that makes an
* available spectrum request) is required whether the master device is making the request on its
* own behalf or on behalf of a slave device (one without geolocation capability). The location
* must be the location of the radiation center of the master device's antenna. To support mobile
* devices, a regulatory domain may allow the anticipated position of the master device to be
* given instead. If the location specifies a region, rather than a point, the database may return
* an UNIMPLEMENTED error code if it does not support query by region.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GeoLocation location;
/**
* When an available spectrum request is made by the master device (a device with geolocation
* capability) on behalf of a slave device (a device without geolocation capability), the rules of
* the applicable regulatory domain may require the master device to provide its own device
* descriptor information (in addition to device descriptor information for the slave device,
* which is provided in a separate parameter).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private DeviceDescriptor masterDeviceDesc;
/**
* Depending on device type and regulatory domain, device owner information may be included in an
* available spectrum request. This allows the device to register and get spectrum-availability
* information in a single request.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private DeviceOwner owner;
/**
* The request type parameter is an optional parameter that can be used to modify an available
* spectrum request, but its use depends on applicable regulatory rules. It may be used, for
* example, to request generic slave device parameters without having to specify the device
* descriptor for a specific device. When the requestType parameter is missing, the request is for
* a specific device (master or slave), and the deviceDesc parameter for the device on whose
* behalf the request is made is required.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String requestType;
/**
* 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;
/**
* Depending on device type and regulatory domain, the characteristics of the antenna may be
* required.
* @return value or {@code null} for none
*/
public AntennaCharacteristics getAntenna() {
return antenna;
}
/**
* Depending on device type and regulatory domain, the characteristics of the antenna may be
* required.
* @param antenna antenna or {@code null} for none
*/
public PawsGetSpectrumRequest setAntenna(AntennaCharacteristics antenna) {
this.antenna = antenna;
return this;
}
/**
* The master device may include its device capabilities to limit the available-spectrum response
* to the spectrum that is compatible with its capabilities. The database should not return
* spectrum that is incompatible with the specified capabilities.
* @return value or {@code null} for none
*/
public DeviceCapabilities getCapabilities() {
return capabilities;
}
/**
* The master device may include its device capabilities to limit the available-spectrum response
* to the spectrum that is compatible with its capabilities. The database should not return
* spectrum that is incompatible with the specified capabilities.
* @param capabilities capabilities or {@code null} for none
*/
public PawsGetSpectrumRequest setCapabilities(DeviceCapabilities capabilities) {
this.capabilities = capabilities;
return this;
}
/**
* When the available spectrum request is made on behalf of a specific device (a master or slave
* device), device descriptor information for that device is required (in such cases, the
* requestType parameter must be empty). When a requestType value is specified, device descriptor
* information may be optional or required according to the rules of the applicable regulatory
* domain.
* @return value or {@code null} for none
*/
public DeviceDescriptor getDeviceDesc() {
return deviceDesc;
}
/**
* When the available spectrum request is made on behalf of a specific device (a master or slave
* device), device descriptor information for that device is required (in such cases, the
* requestType parameter must be empty). When a requestType value is specified, device descriptor
* information may be optional or required according to the rules of the applicable regulatory
* domain.
* @param deviceDesc deviceDesc or {@code null} for none
*/
public PawsGetSpectrumRequest setDeviceDesc(DeviceDescriptor deviceDesc) {
this.deviceDesc = deviceDesc;
return this;
}
/**
* The geolocation of the master device (a device with geolocation capability that makes an
* available spectrum request) is required whether the master device is making the request on its
* own behalf or on behalf of a slave device (one without geolocation capability). The location
* must be the location of the radiation center of the master device's antenna. To support mobile
* devices, a regulatory domain may allow the anticipated position of the master device to be
* given instead. If the location specifies a region, rather than a point, the database may return
* an UNIMPLEMENTED error code if it does not support query by region.
* @return value or {@code null} for none
*/
public GeoLocation getLocation() {
return location;
}
/**
* The geolocation of the master device (a device with geolocation capability that makes an
* available spectrum request) is required whether the master device is making the request on its
* own behalf or on behalf of a slave device (one without geolocation capability). The location
* must be the location of the radiation center of the master device's antenna. To support mobile
* devices, a regulatory domain may allow the anticipated position of the master device to be
* given instead. If the location specifies a region, rather than a point, the database may return
* an UNIMPLEMENTED error code if it does not support query by region.
* @param location location or {@code null} for none
*/
public PawsGetSpectrumRequest setLocation(GeoLocation location) {
this.location = location;
return this;
}
/**
* When an available spectrum request is made by the master device (a device with geolocation
* capability) on behalf of a slave device (a device without geolocation capability), the rules of
* the applicable regulatory domain may require the master device to provide its own device
* descriptor information (in addition to device descriptor information for the slave device,
* which is provided in a separate parameter).
* @return value or {@code null} for none
*/
public DeviceDescriptor getMasterDeviceDesc() {
return masterDeviceDesc;
}
/**
* When an available spectrum request is made by the master device (a device with geolocation
* capability) on behalf of a slave device (a device without geolocation capability), the rules of
* the applicable regulatory domain may require the master device to provide its own device
* descriptor information (in addition to device descriptor information for the slave device,
* which is provided in a separate parameter).
* @param masterDeviceDesc masterDeviceDesc or {@code null} for none
*/
public PawsGetSpectrumRequest setMasterDeviceDesc(DeviceDescriptor masterDeviceDesc) {
this.masterDeviceDesc = masterDeviceDesc;
return this;
}
/**
* Depending on device type and regulatory domain, device owner information may be included in an
* available spectrum request. This allows the device to register and get spectrum-availability
* information in a single request.
* @return value or {@code null} for none
*/
public DeviceOwner getOwner() {
return owner;
}
/**
* Depending on device type and regulatory domain, device owner information may be included in an
* available spectrum request. This allows the device to register and get spectrum-availability
* information in a single request.
* @param owner owner or {@code null} for none
*/
public PawsGetSpectrumRequest setOwner(DeviceOwner owner) {
this.owner = owner;
return this;
}
/**
* The request type parameter is an optional parameter that can be used to modify an available
* spectrum request, but its use depends on applicable regulatory rules. It may be used, for
* example, to request generic slave device parameters without having to specify the device
* descriptor for a specific device. When the requestType parameter is missing, the request is for
* a specific device (master or slave), and the deviceDesc parameter for the device on whose
* behalf the request is made is required.
* @return value or {@code null} for none
*/
public java.lang.String getRequestType() {
return requestType;
}
/**
* The request type parameter is an optional parameter that can be used to modify an available
* spectrum request, but its use depends on applicable regulatory rules. It may be used, for
* example, to request generic slave device parameters without having to specify the device
* descriptor for a specific device. When the requestType parameter is missing, the request is for
* a specific device (master or slave), and the deviceDesc parameter for the device on whose
* behalf the request is made is required.
* @param requestType requestType or {@code null} for none
*/
public PawsGetSpectrumRequest setRequestType(java.lang.String requestType) {
this.requestType = requestType;
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 PawsGetSpectrumRequest 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 PawsGetSpectrumRequest setVersion(java.lang.String version) {
this.version = version;
return this;
}
@Override
public PawsGetSpectrumRequest set(String fieldName, Object value) {
return (PawsGetSpectrumRequest) super.set(fieldName, value);
}
@Override
public PawsGetSpectrumRequest clone() {
return (PawsGetSpectrumRequest) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy