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

Class CreatePipelineRequest

    • Method Detail

      • pipelineName

        public final String pipelineName()

        The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.

        Returns:
        The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.

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

      • pipelineConfigurationBody

        public final String pipelineConfigurationBody()

        The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \n.

        Returns:
        The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \n.

      • logPublishingOptions

        public final LogPublishingOptions logPublishingOptions()

        Key-value pairs to configure log publishing.

        Returns:
        Key-value pairs to configure log publishing.

      • vpcOptions

        public final VpcOptions vpcOptions()

        Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.

        Returns:
        Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.

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

        List of tags to add to the pipeline upon creation.

        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:
        List of tags to add to the pipeline upon creation.

      • 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