Class CreateLicenseManagerReportGeneratorRequest

    • Method Detail

      • reportGeneratorName

        public final String reportGeneratorName()

        Name of the report generator.

        Returns:
        Name of the report generator.
      • type

        public final List<ReportType> type()

        Type of reports to generate. The following report types an be generated:

        • License configuration report - Reports the number and details of consumed licenses for a license configuration.

        • Resource report - Reports the tracked licenses and resource consumption for a license configuration.

        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 hasType() method.

        Returns:
        Type of reports to generate. The following report types an be generated:

        • License configuration report - Reports the number and details of consumed licenses for a license configuration.

        • Resource report - Reports the tracked licenses and resource consumption for a license configuration.

      • hasType

        public final boolean hasType()
        For responses, this returns true if the service returned a value for the Type 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.
      • typeAsStrings

        public final List<String> typeAsStrings()

        Type of reports to generate. The following report types an be generated:

        • License configuration report - Reports the number and details of consumed licenses for a license configuration.

        • Resource report - Reports the tracked licenses and resource consumption for a license configuration.

        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 hasType() method.

        Returns:
        Type of reports to generate. The following report types an be generated:

        • License configuration report - Reports the number and details of consumed licenses for a license configuration.

        • Resource report - Reports the tracked licenses and resource consumption for a license configuration.

      • reportContext

        public final ReportContext reportContext()

        Defines the type of license configuration the report generator tracks.

        Returns:
        Defines the type of license configuration the report generator tracks.
      • reportFrequency

        public final ReportFrequency reportFrequency()

        Frequency by which reports are generated. Reports can be generated daily, monthly, or weekly.

        Returns:
        Frequency by which reports are generated. Reports can be generated daily, monthly, or weekly.
      • clientToken

        public final String clientToken()

        Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

        Returns:
        Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      • description

        public final String description()

        Description of the report generator.

        Returns:
        Description of the report generator.
      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags 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.
      • tags

        public final List<Tag> tags()

        Tags to add to the report generator.

        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 hasTags() method.

        Returns:
        Tags to add to the report generator.
      • 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