Package software.amazon.awssdk.services.osis.model

Class Pipeline

    • Method Detail

      • pipelineName

        public final String pipelineName()

        The name of the pipeline.

        Returns:
        The name of the pipeline.

      • pipelineArn

        public final String pipelineArn()

        The Amazon Resource Name (ARN) of the pipeline.

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

      • minUnits

        public final Integer minUnits()

        The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

        Returns:
        The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

      • maxUnits

        public final Integer maxUnits()

        The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

        Returns:
        The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

      • statusAsString

        public final String statusAsString()

        The current status of the pipeline.

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

        Returns:
        The current status of the pipeline.
        See Also:
        PipelineStatus

      • statusReason

        public final PipelineStatusReason statusReason()

        The reason for the current status of the pipeline.

        Returns:
        The reason for the current status of the pipeline.

      • pipelineConfigurationBody

        public final String pipelineConfigurationBody()

        The Data Prepper pipeline configuration in YAML format.

        Returns:
        The Data Prepper pipeline configuration in YAML format.

      • createdAt

        public final Instant createdAt()

        The date and time when the pipeline was created.

        Returns:
        The date and time when the pipeline was created.

      • lastUpdatedAt

        public final Instant lastUpdatedAt()

        The date and time when the pipeline was last updated.

        Returns:
        The date and time when the pipeline was last updated.

      • hasIngestEndpointUrls

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

      • ingestEndpointUrls

        public final List<String> ingestEndpointUrls()

        The ingestion endpoints for the pipeline, which you can send data 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 hasIngestEndpointUrls() method.

        Returns:
        The ingestion endpoints for the pipeline, which you can send data to.

      • logPublishingOptions

        public final LogPublishingOptions logPublishingOptions()

        Key-value pairs that represent log publishing settings.

        Returns:
        Key-value pairs that represent log publishing settings.

      • hasVpcEndpoints

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

      • vpcEndpoints

        public final List<VpcEndpoint> vpcEndpoints()

        The VPC interface endpoints that have access to the pipeline.

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

        Returns:
        The VPC interface endpoints that have access to the pipeline.

      • bufferOptions

        public final BufferOptions bufferOptions()
        Returns the value of the BufferOptions property for this object.
        Returns:
        The value of the BufferOptions property for this object.

      • encryptionAtRestOptions

        public final EncryptionAtRestOptions encryptionAtRestOptions()
        Returns the value of the EncryptionAtRestOptions property for this object.
        Returns:
        The value of the EncryptionAtRestOptions property for this object.

      • vpcEndpointService

        public final String vpcEndpointService()

        The VPC endpoint service name for the pipeline.

        Returns:
        The VPC endpoint service name for the pipeline.

      • hasServiceVpcEndpoints

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

      • serviceVpcEndpoints

        public final List<ServiceVpcEndpoint> serviceVpcEndpoints()

        A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.

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

        Returns:
        A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.

      • hasDestinations

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

      • destinations

        public final List<PipelineDestination> destinations()

        Destinations to which the pipeline writes data.

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

        Returns:
        Destinations to which the pipeline writes data.

      • 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 List<Tag> tags()

        A list of tags associated with the given pipeline.

        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:
        A list of tags associated with the given pipeline.

      • hashCode

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

      • equals

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

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