Class RegisteredService

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

Represents a registered service with its configuration and accessible resources.

See Also:

  • Method Details

    • serviceId

      public final String serviceId()

      The unique identifier of a service.

      Returns:
      The unique identifier of a service.

    • serviceType

      public final Service serviceType()

      The service type e.g github or dynatrace

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

      Returns:
      The service type e.g github or dynatrace
      See Also:

    • serviceTypeAsString

      public final String serviceTypeAsString()

      The service type e.g github or dynatrace

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

      Returns:
      The service type e.g github or dynatrace
      See Also:

    • name

      public final String name()

      The display name of the registered service.

      Returns:
      The display name of the registered service.

    • hasAccessibleResources

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

    • accessibleResources

      public final List<Document> accessibleResources()

      List of accessible resources for this service.

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

      Returns:
      List of accessible resources for this service.

    • additionalServiceDetails

      public final AdditionalServiceDetails additionalServiceDetails()

      Additional details specific to the service type.

      Returns:
      Additional details specific to the service type.

    • kmsKeyArn

      public final String kmsKeyArn()

      The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt resources.

      Returns:
      The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt resources.

    • privateConnectionName

      public final String privateConnectionName()

      The name of the private connection used for VPC connectivity.

      Returns:
      The name of the private connection used for VPC connectivity.

    • toBuilder

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

    • builder

      public static RegisteredService.Builder builder()

    • serializableBuilderClass

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