Class Integration

java.lang.Object
software.amazon.awssdk.services.cloudwatchomni.model.Integration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Integration.Builder,Integration>
@Generated("software.amazon.awssdk:codegen") public final class Integration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Integration.Builder,Integration>

A connection between CloudWatch and an external system — such as a source of telemetry or configuration data, a messaging destination, or a model provider.

See Also:

  • Method Details

    • integrationId

      public final String integrationId()

      The unique identifier of the integration.

      Returns:
      The unique identifier of the integration.

    • integrationArn

      public final String integrationArn()

      The Amazon Resource Name (ARN) of the integration.

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

    • integrationType

      public final IntegrationType integrationType()
      Returns the value of the IntegrationType property for this object.

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

      Returns:
      The value of the IntegrationType property for this object.
      See Also:

    • integrationTypeAsString

      public final String integrationTypeAsString()
      Returns the value of the IntegrationType property for this object.

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

      Returns:
      The value of the IntegrationType property for this object.
      See Also:

    • name

      public final String name()

      The customer-provided name of the integration.

      Returns:
      The customer-provided name of the integration.

    • status

      public final IntegrationStatus status()
      Returns the value of the Status property for this object.

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

      Returns:
      The value of the Status property for this object.
      See Also:

    • statusAsString

      public final String statusAsString()
      Returns the value of the Status property for this object.

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

      Returns:
      The value of the Status property for this object.
      See Also:

    • authType

      public final AuthType authType()
      Returns the value of the AuthType property for this object.

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

      Returns:
      The value of the AuthType property for this object.
      See Also:

    • authTypeAsString

      public final String authTypeAsString()
      Returns the value of the AuthType property for this object.

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

      Returns:
      The value of the AuthType property for this object.
      See Also:

    • credentialArn

      public final String credentialArn()

      The Amazon Resource Name (ARN) of the secret that stores the integration's credentials.

      Returns:
      The Amazon Resource Name (ARN) of the secret that stores the integration's credentials.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to access the external system.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to access the external system.

    • hasIntegrationAttributes

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

    • integrationAttributes

      public final Map<String,String> integrationAttributes()

      Provider-specific key/value attributes that configure the integration.

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

      Returns:
      Provider-specific key/value attributes that configure the integration.

    • authorizationUrl

      public final String authorizationUrl()

      The URL the customer visits to authorize the integration. Present while an OAuth authorization is pending.

      Returns:
      The URL the customer visits to authorize the integration. Present while an OAuth authorization is pending.

    • errorMessage

      public final String errorMessage()

      A human-readable description of why the integration is in an ERROR or FAILED state. Present only when the integration has failed.

      Returns:
      A human-readable description of why the integration is in an ERROR or FAILED state. Present only when the integration has failed.

    • createdAt

      public final Instant createdAt()

      The time at which the integration was created.

      Returns:
      The time at which the integration was created.

    • updatedAt

      public final Instant updatedAt()

      The time at which the integration was last updated.

      Returns:
      The time at which the integration was last updated.

    • scope

      public final Scope scope()

      Whether this integration is account-scoped (ACCOUNT, customer-created) or organization-scoped (ORGANIZATION, created by an org-enablement rule). Absent on legacy records is treated as ACCOUNT.

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

      Returns:
      Whether this integration is account-scoped (ACCOUNT, customer-created) or organization-scoped (ORGANIZATION, created by an org-enablement rule). Absent on legacy records is treated as ACCOUNT.
      See Also:

    • scopeAsString

      public final String scopeAsString()

      Whether this integration is account-scoped (ACCOUNT, customer-created) or organization-scoped (ORGANIZATION, created by an org-enablement rule). Absent on legacy records is treated as ACCOUNT.

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

      Returns:
      Whether this integration is account-scoped (ACCOUNT, customer-created) or organization-scoped (ORGANIZATION, created by an org-enablement rule). Absent on legacy records is treated as ACCOUNT.
      See Also:

    • toBuilder

      public Integration.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<Integration.Builder,Integration>
      Returns:
      a builder for type T

    • builder

      public static Integration.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.