Class CreatePipelineRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreatePipelineRequest.Builder,
CreatePipelineRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal BufferOptions
Key-value pairs to configure persistent buffering for the pipeline.builder()
final EncryptionAtRestOptions
Key-value pairs to configure encryption for data that is written to a persistent buffer.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final LogPublishingOptions
Key-value pairs to configure log publishing.final Integer
maxUnits()
The maximum pipeline capacity, in Ingestion Compute Units (ICUs).final Integer
minUnits()
The minimum pipeline capacity, in Ingestion Compute Units (ICUs).final String
The pipeline configuration in YAML format.final String
The name of the OpenSearch Ingestion pipeline to create.static Class
<? extends CreatePipelineRequest.Builder> tags()
List of tags to add to the pipeline upon creation.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final VpcOptions
Container for the values required to configure VPC access for the pipeline.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
- Returns:
- The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
-
maxUnits
The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
- Returns:
- The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
-
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
Key-value pairs to configure log publishing.
- Returns:
- Key-value pairs to configure log publishing.
-
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.
-
bufferOptions
Key-value pairs to configure persistent buffering for the pipeline.
- Returns:
- Key-value pairs to configure persistent buffering for the pipeline.
-
encryptionAtRestOptions
Key-value pairs to configure encryption for data that is written to a persistent buffer.
- Returns:
- Key-value pairs to configure encryption for data that is written to a persistent buffer.
-
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 theisEmpty()
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
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.
-
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 interfaceToCopyableBuilder<CreatePipelineRequest.Builder,
CreatePipelineRequest> - Specified by:
toBuilder
in classOsisRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-