com.pulumi.meraki.organizations.inputs.GetSensorReadingsLatestPlainArgs Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of meraki Show documentation
Show all versions of meraki Show documentation
A Pulumi package for creating and managing Cisco Meraki resources
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.meraki.organizations.inputs;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class GetSensorReadingsLatestPlainArgs extends com.pulumi.resources.InvokeArgs {
public static final GetSensorReadingsLatestPlainArgs Empty = new GetSensorReadingsLatestPlainArgs();
/**
* endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
*
*/
@Import(name="endingBefore")
private @Nullable String endingBefore;
/**
* @return endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
*
*/
public Optional endingBefore() {
return Optional.ofNullable(this.endingBefore);
}
/**
* metrics query parameter. Types of sensor readings to retrieve. If no metrics are supplied, all available types of readings will be retrieved. Allowed values are apparentPower, battery, button, co2, current, door, downstreamPower, frequency, humidity, indoorAirQuality, noise, pm25, powerFactor, realPower, remoteLockoutSwitch, temperature, tvoc, voltage, and water.
*
*/
@Import(name="metrics")
private @Nullable List metrics;
/**
* @return metrics query parameter. Types of sensor readings to retrieve. If no metrics are supplied, all available types of readings will be retrieved. Allowed values are apparentPower, battery, button, co2, current, door, downstreamPower, frequency, humidity, indoorAirQuality, noise, pm25, powerFactor, realPower, remoteLockoutSwitch, temperature, tvoc, voltage, and water.
*
*/
public Optional> metrics() {
return Optional.ofNullable(this.metrics);
}
/**
* networkIds query parameter. Optional parameter to filter readings by network.
*
*/
@Import(name="networkIds")
private @Nullable List networkIds;
/**
* @return networkIds query parameter. Optional parameter to filter readings by network.
*
*/
public Optional> networkIds() {
return Optional.ofNullable(this.networkIds);
}
/**
* organizationId path parameter. Organization ID
*
*/
@Import(name="organizationId", required=true)
private String organizationId;
/**
* @return organizationId path parameter. Organization ID
*
*/
public String organizationId() {
return this.organizationId;
}
/**
* perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
*
*/
@Import(name="perPage")
private @Nullable Integer perPage;
/**
* @return perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
*
*/
public Optional perPage() {
return Optional.ofNullable(this.perPage);
}
/**
* serials query parameter. Optional parameter to filter readings by sensor.
*
*/
@Import(name="serials")
private @Nullable List serials;
/**
* @return serials query parameter. Optional parameter to filter readings by sensor.
*
*/
public Optional> serials() {
return Optional.ofNullable(this.serials);
}
/**
* startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
*
*/
@Import(name="startingAfter")
private @Nullable String startingAfter;
/**
* @return startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
*
*/
public Optional startingAfter() {
return Optional.ofNullable(this.startingAfter);
}
private GetSensorReadingsLatestPlainArgs() {}
private GetSensorReadingsLatestPlainArgs(GetSensorReadingsLatestPlainArgs $) {
this.endingBefore = $.endingBefore;
this.metrics = $.metrics;
this.networkIds = $.networkIds;
this.organizationId = $.organizationId;
this.perPage = $.perPage;
this.serials = $.serials;
this.startingAfter = $.startingAfter;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(GetSensorReadingsLatestPlainArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private GetSensorReadingsLatestPlainArgs $;
public Builder() {
$ = new GetSensorReadingsLatestPlainArgs();
}
public Builder(GetSensorReadingsLatestPlainArgs defaults) {
$ = new GetSensorReadingsLatestPlainArgs(Objects.requireNonNull(defaults));
}
/**
* @param endingBefore endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
*
* @return builder
*
*/
public Builder endingBefore(@Nullable String endingBefore) {
$.endingBefore = endingBefore;
return this;
}
/**
* @param metrics metrics query parameter. Types of sensor readings to retrieve. If no metrics are supplied, all available types of readings will be retrieved. Allowed values are apparentPower, battery, button, co2, current, door, downstreamPower, frequency, humidity, indoorAirQuality, noise, pm25, powerFactor, realPower, remoteLockoutSwitch, temperature, tvoc, voltage, and water.
*
* @return builder
*
*/
public Builder metrics(@Nullable List metrics) {
$.metrics = metrics;
return this;
}
/**
* @param metrics metrics query parameter. Types of sensor readings to retrieve. If no metrics are supplied, all available types of readings will be retrieved. Allowed values are apparentPower, battery, button, co2, current, door, downstreamPower, frequency, humidity, indoorAirQuality, noise, pm25, powerFactor, realPower, remoteLockoutSwitch, temperature, tvoc, voltage, and water.
*
* @return builder
*
*/
public Builder metrics(String... metrics) {
return metrics(List.of(metrics));
}
/**
* @param networkIds networkIds query parameter. Optional parameter to filter readings by network.
*
* @return builder
*
*/
public Builder networkIds(@Nullable List networkIds) {
$.networkIds = networkIds;
return this;
}
/**
* @param networkIds networkIds query parameter. Optional parameter to filter readings by network.
*
* @return builder
*
*/
public Builder networkIds(String... networkIds) {
return networkIds(List.of(networkIds));
}
/**
* @param organizationId organizationId path parameter. Organization ID
*
* @return builder
*
*/
public Builder organizationId(String organizationId) {
$.organizationId = organizationId;
return this;
}
/**
* @param perPage perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 1000.
*
* @return builder
*
*/
public Builder perPage(@Nullable Integer perPage) {
$.perPage = perPage;
return this;
}
/**
* @param serials serials query parameter. Optional parameter to filter readings by sensor.
*
* @return builder
*
*/
public Builder serials(@Nullable List serials) {
$.serials = serials;
return this;
}
/**
* @param serials serials query parameter. Optional parameter to filter readings by sensor.
*
* @return builder
*
*/
public Builder serials(String... serials) {
return serials(List.of(serials));
}
/**
* @param startingAfter startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
*
* @return builder
*
*/
public Builder startingAfter(@Nullable String startingAfter) {
$.startingAfter = startingAfter;
return this;
}
public GetSensorReadingsLatestPlainArgs build() {
if ($.organizationId == null) {
throw new MissingRequiredPropertyException("GetSensorReadingsLatestPlainArgs", "organizationId");
}
return $;
}
}
}