Klasse GetTransactionsOperationSpec

java.lang.Object
io.github.primelib.webmethodsapigateway4j.operations.GetTransactionsOperationSpec
@Generated("io.github.primelib.primecodegen") public class GetTransactionsOperationSpec extends Object
GetTransactions

This method can be used to retrieve the transaction events for a given API/Application/Plan/Package for a specific period of time. Multiple request parameters of this method provide options to specify the request criteria to match the expected result and most of these input parameters supports regular expression in their values. Along with the mandatory parameters - fromDate and toDate, any one of the other filter criteria should be passed in the request.

  • Feldübersicht

    Felder
    Modifizierer und Typ
    Feld
    Beschreibung
    static Boolean
    VALIDATION_ENABLED
    allows to disable validation of the spec, use with care!

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    GetTransactionsOperationSpec(Consumer<GetTransactionsOperationSpec> spec)
    Constructs a validated instance of GetTransactionsOperationSpec.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    @Nullable String
    apiId()
    The system generated id for an API.The id of an can be retrieved from the API details screen
    GetTransactionsOperationSpec
    apiId(@Nullable String apiId)
    The system generated id for an API.The id of an can be retrieved from the API details screen
    @Nullable String
    apiName()
    The name of the API for which the invocation details is required.The exact name must be provided or regular expressions can be used like API_.*
    GetTransactionsOperationSpec
    apiName(@Nullable String apiName)
    The name of the API for which the invocation details is required.The exact name must be provided or regular expressions can be used like API_.*
    @Nullable String
    apiVersion()
    The version of the API
    GetTransactionsOperationSpec
    apiVersion(@Nullable String apiVersion)
    The version of the API
    @Nullable String
    applicationId()
    The system generated id for an Application.The id of an can be retrieved from the Application details screen
    GetTransactionsOperationSpec
    applicationId(@Nullable String applicationId)
    The system generated id for an Application.The id of an can be retrieved from the Application details screen
    @Nullable String
    applicationName()
    The name of the Application for which the invocation details is required.The exact name must be provided or regular expressions can be used like APP_.*
    GetTransactionsOperationSpec
    applicationName(@Nullable String applicationName)
    The name of the Application for which the invocation details is required.The exact name must be provided or regular expressions can be used like APP_.*
    protected boolean
    canEqual(Object other)
     
    boolean
    equals(Object o)
     
    @Nullable Integer
    from()
    This parameter specifies the index from which the data has to be retrieved from the store.
    GetTransactionsOperationSpec
    from(@Nullable Integer from)
    This parameter specifies the index from which the data has to be retrieved from the store.
    @NonNull Instant
    fromDate()
    This is the date from which the invocation details has to be retrieved for the matching filter criteria.It is a mandatory parameter and it should be of the format YYYY-MM-DD.
    GetTransactionsOperationSpec
    fromDate(@NonNull Instant fromDate)
    This is the date from which the invocation details has to be retrieved for the matching filter criteria.It is a mandatory parameter and it should be of the format YYYY-MM-DD.
    int
    hashCode()
     
    @Nullable String
    packageId()
    The system generated id for a Package.The id of an can be retrieved from the Package details screen
    GetTransactionsOperationSpec
    packageId(@Nullable String packageId)
    The system generated id for a Package.The id of an can be retrieved from the Package details screen
    @Nullable String
    packageName()
    The name of the Package for which the invocation details is required.The exact name must be provided or regular expressions can be used like Package_.*
    GetTransactionsOperationSpec
    packageName(@Nullable String packageName)
    The name of the Package for which the invocation details is required.The exact name must be provided or regular expressions can be used like Package_.*
    @Nullable String
    planId()
    The system generated id for a Plan.The id of an can be retrieved from the Plan details screen
    GetTransactionsOperationSpec
    planId(@Nullable String planId)
    The system generated id for a Plan.The id of an can be retrieved from the Plan details screen
    @Nullable String
    planName()
    The name of the Plan for which the invocation details is required.The exact name must be provided or regular expressions can be used like Plan_.*
    GetTransactionsOperationSpec
    planName(@Nullable String planName)
    The name of the Plan for which the invocation details is required.The exact name must be provided or regular expressions can be used like Plan_.*
    @Nullable Integer
    size()
    This parameter specifies the number of records that should be present in the response.
    GetTransactionsOperationSpec
    size(@Nullable Integer size)
    This parameter specifies the number of records that should be present in the response.
    @NonNull Instant
    toDate()
    This is the date to which the invocation details has to be retrieved for the matching filter criteria.It is a mandatory parameter and it should be of the format YYYY-MM-DD.
    GetTransactionsOperationSpec
    toDate(@NonNull Instant toDate)
    This is the date to which the invocation details has to be retrieved for the matching filter criteria.It is a mandatory parameter and it should be of the format YYYY-MM-DD.
    String
    toString()
     
    void
    validate()
    Validates the Spec, will throw a exception if required parameters are missing

    Von Klasse geerbte Methoden java.lang.Object

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

  • Felddetails

    • VALIDATION_ENABLED

      @Experimental public static Boolean VALIDATION_ENABLED
      allows to disable validation of the spec, use with care!

  • Konstruktordetails

  • Methodendetails

    • validate

      public void validate()
      Validates the Spec, will throw a exception if required parameters are missing
      Löst aus:
      NullPointerException

    • apiName

      public @Nullable String apiName()
      The name of the API for which the invocation details is required.The exact name must be provided or regular expressions can be used like API_.*

    • apiVersion

      public @Nullable String apiVersion()
      The version of the API

    • apiId

      public @Nullable String apiId()
      The system generated id for an API.The id of an can be retrieved from the API details screen

    • applicationName

      public @Nullable String applicationName()
      The name of the Application for which the invocation details is required.The exact name must be provided or regular expressions can be used like APP_.*

    • applicationId

      public @Nullable String applicationId()
      The system generated id for an Application.The id of an can be retrieved from the Application details screen

    • packageName

      public @Nullable String packageName()
      The name of the Package for which the invocation details is required.The exact name must be provided or regular expressions can be used like Package_.*

    • packageId

      public @Nullable String packageId()
      The system generated id for a Package.The id of an can be retrieved from the Package details screen

    • planName

      public @Nullable String planName()
      The name of the Plan for which the invocation details is required.The exact name must be provided or regular expressions can be used like Plan_.*

    • planId

      public @Nullable String planId()
      The system generated id for a Plan.The id of an can be retrieved from the Plan details screen

    • from

      public @Nullable Integer from()
      This parameter specifies the index from which the data has to be retrieved from the store. It is mainly used during pagination where the data is retrieved in batches

    • size

      public @Nullable Integer size()
      This parameter specifies the number of records that should be present in the response. This can be combined with the parameter - from to get the records in batches during pagination.

    • fromDate

      public @NonNull Instant fromDate()
      This is the date from which the invocation details has to be retrieved for the matching filter criteria.It is a mandatory parameter and it should be of the format YYYY-MM-DD. Regular expression support is not available for this parameter

    • toDate

      public @NonNull Instant toDate()
      This is the date to which the invocation details has to be retrieved for the matching filter criteria.It is a mandatory parameter and it should be of the format YYYY-MM-DD. Regular expression support is not available for this parameter

    • apiName

      public GetTransactionsOperationSpec apiName(@Nullable String apiName)
      The name of the API for which the invocation details is required.The exact name must be provided or regular expressions can be used like API_.*
      Gibt zurück:
      this.

    • apiVersion

      public GetTransactionsOperationSpec apiVersion(@Nullable String apiVersion)
      The version of the API
      Gibt zurück:
      this.

    • apiId

      public GetTransactionsOperationSpec apiId(@Nullable String apiId)
      The system generated id for an API.The id of an can be retrieved from the API details screen
      Gibt zurück:
      this.

    • applicationName

      public GetTransactionsOperationSpec applicationName(@Nullable String applicationName)
      The name of the Application for which the invocation details is required.The exact name must be provided or regular expressions can be used like APP_.*
      Gibt zurück:
      this.

    • applicationId

      public GetTransactionsOperationSpec applicationId(@Nullable String applicationId)
      The system generated id for an Application.The id of an can be retrieved from the Application details screen
      Gibt zurück:
      this.

    • packageName

      public GetTransactionsOperationSpec packageName(@Nullable String packageName)
      The name of the Package for which the invocation details is required.The exact name must be provided or regular expressions can be used like Package_.*
      Gibt zurück:
      this.

    • packageId

      public GetTransactionsOperationSpec packageId(@Nullable String packageId)
      The system generated id for a Package.The id of an can be retrieved from the Package details screen
      Gibt zurück:
      this.

    • planName

      public GetTransactionsOperationSpec planName(@Nullable String planName)
      The name of the Plan for which the invocation details is required.The exact name must be provided or regular expressions can be used like Plan_.*
      Gibt zurück:
      this.

    • planId

      public GetTransactionsOperationSpec planId(@Nullable String planId)
      The system generated id for a Plan.The id of an can be retrieved from the Plan details screen
      Gibt zurück:
      this.

    • from

      public GetTransactionsOperationSpec from(@Nullable Integer from)
      This parameter specifies the index from which the data has to be retrieved from the store. It is mainly used during pagination where the data is retrieved in batches
      Gibt zurück:
      this.

    • size

      public GetTransactionsOperationSpec size(@Nullable Integer size)
      This parameter specifies the number of records that should be present in the response. This can be combined with the parameter - from to get the records in batches during pagination.
      Gibt zurück:
      this.

    • fromDate

      public GetTransactionsOperationSpec fromDate(@NonNull Instant fromDate)
      This is the date from which the invocation details has to be retrieved for the matching filter criteria.It is a mandatory parameter and it should be of the format YYYY-MM-DD. Regular expression support is not available for this parameter
      Gibt zurück:
      this.

    • toDate

      public GetTransactionsOperationSpec toDate(@NonNull Instant toDate)
      This is the date to which the invocation details has to be retrieved for the matching filter criteria.It is a mandatory parameter and it should be of the format YYYY-MM-DD. Regular expression support is not available for this parameter
      Gibt zurück:
      this.

    • equals

      public boolean equals(Object o)
      Setzt außer Kraft:
      equals in Klasse Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Setzt außer Kraft:
      hashCode in Klasse Object

    • toString

      public String toString()
      Setzt außer Kraft:
      toString in Klasse Object