Class GetAccountBalanceRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetAccountBalanceRequest.Builder,GetAccountBalanceRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal BalanceTypeThe balance to retrieve.final StringThe balance to retrieve.builder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final inthashCode()final IntegerThe maximum number of results to return in one page.final StringThe pagination token from thenextTokenof the previous response.static Class<? extends GetAccountBalanceRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
balanceType
The balance to retrieve. You can specify only one balance type in a single request. Each balance adds up the
outstandingbalance of the records that have the statusOUTSTANDING. A record that isPROCESSING,SETTLED, orCANCELEDisn't included, even when part of its amount is outstanding. The following values are valid:-
INVOICES_DUE– The outstanding balance of yourOUTSTANDINGinvoices that aren't past their due date, wheredueStatusisDUE. -
INVOICES_PAST_DUE– The outstanding balance of yourOUTSTANDINGinvoices that are past their due date, wheredueStatusisPAST_DUE. -
OUTSTANDING_CREDIT_MEMOS– The outstanding balance of yourOUTSTANDINGcredit memos: the credit that isn't yet applied to an invoice.
If the service returns an enum value that is not available in the current SDK version,
balanceTypewill returnBalanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frombalanceTypeAsString().- Returns:
- The balance to retrieve. You can specify only one balance type in a single request. Each balance adds up
the
outstandingbalance of the records that have the statusOUTSTANDING. A record that isPROCESSING,SETTLED, orCANCELEDisn't included, even when part of its amount is outstanding. The following values are valid:-
INVOICES_DUE– The outstanding balance of yourOUTSTANDINGinvoices that aren't past their due date, wheredueStatusisDUE. -
INVOICES_PAST_DUE– The outstanding balance of yourOUTSTANDINGinvoices that are past their due date, wheredueStatusisPAST_DUE. -
OUTSTANDING_CREDIT_MEMOS– The outstanding balance of yourOUTSTANDINGcredit memos: the credit that isn't yet applied to an invoice.
-
- See Also:
-
-
balanceTypeAsString
The balance to retrieve. You can specify only one balance type in a single request. Each balance adds up the
outstandingbalance of the records that have the statusOUTSTANDING. A record that isPROCESSING,SETTLED, orCANCELEDisn't included, even when part of its amount is outstanding. The following values are valid:-
INVOICES_DUE– The outstanding balance of yourOUTSTANDINGinvoices that aren't past their due date, wheredueStatusisDUE. -
INVOICES_PAST_DUE– The outstanding balance of yourOUTSTANDINGinvoices that are past their due date, wheredueStatusisPAST_DUE. -
OUTSTANDING_CREDIT_MEMOS– The outstanding balance of yourOUTSTANDINGcredit memos: the credit that isn't yet applied to an invoice.
If the service returns an enum value that is not available in the current SDK version,
balanceTypewill returnBalanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frombalanceTypeAsString().- Returns:
- The balance to retrieve. You can specify only one balance type in a single request. Each balance adds up
the
outstandingbalance of the records that have the statusOUTSTANDING. A record that isPROCESSING,SETTLED, orCANCELEDisn't included, even when part of its amount is outstanding. The following values are valid:-
INVOICES_DUE– The outstanding balance of yourOUTSTANDINGinvoices that aren't past their due date, wheredueStatusisDUE. -
INVOICES_PAST_DUE– The outstanding balance of yourOUTSTANDINGinvoices that are past their due date, wheredueStatusisPAST_DUE. -
OUTSTANDING_CREDIT_MEMOS– The outstanding balance of yourOUTSTANDINGcredit memos: the credit that isn't yet applied to an invoice.
-
- See Also:
-
-
nextToken
The pagination token from the
nextTokenof the previous response. Omit it to get the first page. Tokens expire. If the token is malformed or expired, or doesn't match the original request, the request fails withValidationExceptionand the reasonINVALID_PAGINATION_TOKEN. In that case, start again from the first page.- Returns:
- The pagination token from the
nextTokenof the previous response. Omit it to get the first page. Tokens expire. If the token is malformed or expired, or doesn't match the original request, the request fails withValidationExceptionand the reasonINVALID_PAGINATION_TOKEN. In that case, start again from the first page.
-
maxResults
The maximum number of results to return in one page. The default is 100. A page can contain fewer results even when more remain. Use
nextTokento find out whether more results are available.- Returns:
- The maximum number of results to return in one page. The default is 100. A page can contain fewer results
even when more remain. Use
nextTokento find out whether more results are available.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<GetAccountBalanceRequest.Builder,GetAccountBalanceRequest> - Specified by:
toBuilderin classPaymentsRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- Parameters:
fieldName- The name of the member to be retrieved.clazz- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-