Class CreateServiceTemplateRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.proton.model.ProtonRequest
software.amazon.awssdk.services.proton.model.CreateServiceTemplateRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateServiceTemplateRequest.Builder,CreateServiceTemplateRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateServiceTemplateRequest extends ProtonRequest implements ToCopyableBuilder<CreateServiceTemplateRequest.Builder,CreateServiceTemplateRequest>

  • Method Details

    • description

      public final String description()

      A description of the service template.

      Returns:
      A description of the service template.

    • displayName

      public final String displayName()

      The name of the service template as displayed in the developer interface.

      Returns:
      The name of the service template as displayed in the developer interface.

    • encryptionKey

      public final String encryptionKey()

      A customer provided encryption key that's used to encrypt data.

      Returns:
      A customer provided encryption key that's used to encrypt data.

    • name

      public final String name()

      The name of the service template.

      Returns:
      The name of the service template.

    • pipelineProvisioning

      public final Provisioning pipelineProvisioning()

      By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates that an Proton service pipeline isn't provided for your service. After it's included, it can't be changed. For more information, see Template bundles in the Proton User Guide.

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

      Returns:
      By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates that an Proton service pipeline isn't provided for your service. After it's included, it can't be changed. For more information, see Template bundles in the Proton User Guide.
      See Also:

    • pipelineProvisioningAsString

      public final String pipelineProvisioningAsString()

      By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates that an Proton service pipeline isn't provided for your service. After it's included, it can't be changed. For more information, see Template bundles in the Proton User Guide.

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

      Returns:
      By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates that an Proton service pipeline isn't provided for your service. After it's included, it can't be changed. For more information, see Template bundles in the Proton User Guide.
      See Also:

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

      An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.

      For more information, see Proton resources and tagging in the Proton User Guide.

      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:
      An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.

      For more information, see Proton resources and tagging in the Proton User Guide.

    • toBuilder

      public CreateServiceTemplateRequest.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<CreateServiceTemplateRequest.Builder,CreateServiceTemplateRequest>
      Specified by:
      toBuilder in class ProtonRequest
      Returns:
      a builder for type T

    • builder

      public static CreateServiceTemplateRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      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.