Class CreateAppMonitorRequest

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

  • Method Details

    • appMonitorConfiguration

      public final AppMonitorConfiguration appMonitorConfiguration()

      A structure that contains much of the configuration data for the app monitor. If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration, you must set up your own authorization method. For more information, see Authorize your application to send data to Amazon Web Services.

      If you omit this argument, the sample rate used for RUM is set to 10% of the user sessions.

      Returns:
      A structure that contains much of the configuration data for the app monitor. If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration, you must set up your own authorization method. For more information, see Authorize your application to send data to Amazon Web Services.

      If you omit this argument, the sample rate used for RUM is set to 10% of the user sessions.

    • customEvents

      public final CustomEvents customEvents()

      Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED.

      For more information about custom events, see Send custom events.

      Returns:
      Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED.

      For more information about custom events, see Send custom events.

    • cwLogEnabled

      public final Boolean cwLogEnabled()

      Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.

      If you omit this parameter, the default is false.

      Returns:
      Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.

      If you omit this parameter, the default is false.

    • domain

      public final String domain()

      The top-level internet domain name for which your application has administrative authority.

      Returns:
      The top-level internet domain name for which your application has administrative authority.

    • name

      public final String name()

      A name for the app monitor.

      Returns:
      A name for the app monitor.

    • 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 Map<String,String> tags()

      Assigns one or more tags (key-value pairs) to the app monitor.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

      Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

      You can associate as many as 50 tags with an app monitor.

      For more information, see Tagging Amazon Web Services resources.

      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:
      Assigns one or more tags (key-value pairs) to the app monitor.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

      Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

      You can associate as many as 50 tags with an app monitor.

      For more information, see Tagging Amazon Web Services resources.

    • toBuilder

      public CreateAppMonitorRequest.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<CreateAppMonitorRequest.Builder,CreateAppMonitorRequest>
      Specified by:
      toBuilder in class RumRequest
      Returns:
      a builder for type T

    • builder

      public static CreateAppMonitorRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateAppMonitorRequest.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.