Package software.amazon.awssdk.services.cloudwatchevents.model

Class DescribeRuleResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.cloudwatchevents.model.CloudWatchEventsResponse
software.amazon.awssdk.services.cloudwatchevents.model.DescribeRuleResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeRuleResponse.Builder,DescribeRuleResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeRuleResponse extends CloudWatchEventsResponse implements ToCopyableBuilder<DescribeRuleResponse.Builder,DescribeRuleResponse>

  • Method Details

    • name

      public final String name()

      The name of the rule.

      Returns:
      The name of the rule.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the rule.

      Returns:
      The Amazon Resource Name (ARN) of the rule.

    • eventPattern

      public final String eventPattern()

      The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

      Returns:
      The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

    • scheduleExpression

      public final String scheduleExpression()

      The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

      Returns:
      The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

    • state

      public final RuleState state()

      Specifies whether the rule is enabled or disabled.

      If the service returns an enum value that is not available in the current SDK version, state will return RuleState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      Specifies whether the rule is enabled or disabled.
      See Also:

    • stateAsString

      public final String stateAsString()

      Specifies whether the rule is enabled or disabled.

      If the service returns an enum value that is not available in the current SDK version, state will return RuleState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      Specifies whether the rule is enabled or disabled.
      See Also:

    • description

      public final String description()

      The description of the rule.

      Returns:
      The description of the rule.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the IAM role associated with the rule.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role associated with the rule.

    • managedBy

      public final String managedBy()

      If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.

      Returns:
      If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.

    • eventBusName

      public final String eventBusName()

      The name of the event bus associated with the rule.

      Returns:
      The name of the event bus associated with the rule.

    • createdBy

      public final String createdBy()

      The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.

      Returns:
      The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.

    • toBuilder

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

    • builder

      public static DescribeRuleResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeRuleResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

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