software.amazon.awssdk.services.marketplacemetering.model

Class MeterUsageRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.marketplacemetering.model.MarketplaceMeteringRequest

software.amazon.awssdk.services.marketplacemetering.model.MeterUsageRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<MeterUsageRequest.Builder,MeterUsageRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class MeterUsageRequest
extends MarketplaceMeteringRequest
implements ToCopyableBuilder<MeterUsageRequest.Builder,MeterUsageRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MeterUsageRequest.Builder

Method Summary

Modifier and Type	Method and Description
static MeterUsageRequest.Builder	builder()
Boolean	dryRun() Checks whether you have the permissions required for the action, but does not make the request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasUsageAllocations() For responses, this returns true if the service returned a value for the UsageAllocations property.
String	productCode() Product code is used to uniquely identify a product in AWS Marketplace.
List<SdkField<?>>	sdkFields()
static Class<? extends MeterUsageRequest.Builder>	serializableBuilderClass()
Instant	timestamp() Timestamp, in UTC, for which the usage is being reported.
MeterUsageRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<UsageAllocation>	usageAllocations() The set of UsageAllocations to submit.
String	usageDimension() It will be one of the fcp dimension name provided during the publishing of the product.
Integer	usageQuantity() Consumption value for the hour.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

productCode

public final String productCode()

Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.

Returns:

Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.

timestamp

public final Instant timestamp()

Timestamp, in UTC, for which the usage is being reported. Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.

Returns:

Timestamp, in UTC, for which the usage is being reported. Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.

usageDimension

public final String usageDimension()

It will be one of the fcp dimension name provided during the publishing of the product.

Returns:

It will be one of the fcp dimension name provided during the publishing of the product.

usageQuantity

public final Integer usageQuantity()

Consumption value for the hour. Defaults to 0 if not specified.

Returns:

Consumption value for the hour. Defaults to 0 if not specified.

dryRun

public final Boolean dryRun()

Checks whether you have the permissions required for the action, but does not make the request. If you have the permissions, the request returns DryRunOperation; otherwise, it returns UnauthorizedException. Defaults to false if not specified.

Returns:

Checks whether you have the permissions required for the action, but does not make the request. If you have the permissions, the request returns DryRunOperation; otherwise, it returns UnauthorizedException. Defaults to false if not specified.

hasUsageAllocations

public final boolean hasUsageAllocations()

For responses, this returns true if the service returned a value for the UsageAllocations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

usageAllocations

public final List<UsageAllocation> usageAllocations()

The set of UsageAllocations to submit.

The sum of all UsageAllocation quantities must equal the UsageQuantity of the MeterUsage request, and each UsageAllocation must have a unique set of tags (include no tags).

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUsageAllocations() method.

Returns:

The set of UsageAllocations to submit.

The sum of all UsageAllocation quantities must equal the UsageQuantity of the MeterUsage request, and each UsageAllocation must have a unique set of tags (include no tags).

toBuilder

public MeterUsageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MeterUsageRequest.Builder,MeterUsageRequest>

Specified by:

toBuilder in class MarketplaceMeteringRequest

builder

public static MeterUsageRequest.Builder builder()

serializableBuilderClass

public static Class<? extends MeterUsageRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo