Class ListServiceLevelObjectivesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.applicationsignals.model.ApplicationSignalsRequest
software.amazon.awssdk.services.applicationsignals.model.ListServiceLevelObjectivesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListServiceLevelObjectivesRequest.Builder,ListServiceLevelObjectivesRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListServiceLevelObjectivesRequest extends ApplicationSignalsRequest implements ToCopyableBuilder<ListServiceLevelObjectivesRequest.Builder,ListServiceLevelObjectivesRequest>

  • Method Details

    • hasKeyAttributes

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

    • keyAttributes

      public final Map<String,String> keyAttributes()

      You can use this optional field to specify which services you want to retrieve SLO information for.

      This is a string-to-string map. It can include the following fields.

      • Type designates the type of object this is.

      • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

      • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

      • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

      • Environment specifies the location where this object is hosted, or what it belongs to.

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

      Returns:
      You can use this optional field to specify which services you want to retrieve SLO information for.

      This is a string-to-string map. It can include the following fields.

      • Type designates the type of object this is.

      • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

      • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service .

      • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

      • Environment specifies the location where this object is hosted, or what it belongs to.

    • operationName

      public final String operationName()

      The name of the operation that this SLO is associated with.

      Returns:
      The name of the operation that this SLO is associated with.

    • dependencyConfig

      public final DependencyConfig dependencyConfig()

      Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName .

      Returns:
      Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

      Returns:
      The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

    • nextToken

      public final String nextToken()

      Include this value, if it was returned by the previous operation, to get the next set of service level objectives.

      Returns:
      Include this value, if it was returned by the previous operation, to get the next set of service level objectives.

    • metricSourceTypes

      public final List<MetricSourceType> metricSourceTypes()

      Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:

      • Service operation

      • Service dependency

      • CloudWatch metric

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

      Returns:
      Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:

      • Service operation

      • Service dependency

      • CloudWatch metric

    • hasMetricSourceTypes

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

    • metricSourceTypesAsStrings

      public final List<String> metricSourceTypesAsStrings()

      Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:

      • Service operation

      • Service dependency

      • CloudWatch metric

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

      Returns:
      Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:

      • Service operation

      • Service dependency

      • CloudWatch metric

    • includeLinkedAccounts

      public final Boolean includeLinkedAccounts()

      If you are using this operation in a monitoring account, specify true to include SLO from source accounts in the returned data. 

        </p> <p>When you are monitoring an account, you can use Amazon Web Services account ID in <code>KeyAttribute</code> filter for service source account and <code>SloOwnerawsaccountID</code> for SLO source account with <code>IncludeLinkedAccounts</code> to filter the returned data to only a single source account. </p>
      Returns:
      If you are using this operation in a monitoring account, specify true to include SLO from source accounts in the returned data. 
       
          </p> <p>When you are monitoring an account, you can use Amazon Web Services account ID
         in <code>KeyAttribute</code> filter for service source account and
         <code>SloOwnerawsaccountID</code> for SLO source account with
         <code>IncludeLinkedAccounts</code> to filter the returned data to only a single source
         account. </p>

    • sloOwnerAwsAccountId

      public final String sloOwnerAwsAccountId()

      SLO's Amazon Web Services account ID.

      Returns:
      SLO's Amazon Web Services account ID.

    • toBuilder

      public ListServiceLevelObjectivesRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListServiceLevelObjectivesRequest.Builder,ListServiceLevelObjectivesRequest>
      Specified by:
      toBuilder in class ApplicationSignalsRequest
      Returns:
      a builder for type T

    • builder

      public static ListServiceLevelObjectivesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListServiceLevelObjectivesRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.