Class CreateIngestionRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateIngestionRequest.Builder,CreateIngestionRequest>

@Generated("software.amazon.awssdk:codegen") public final class CreateIngestionRequest extends AppFabricRequest implements ToCopyableBuilder<CreateIngestionRequest.Builder,CreateIngestionRequest>
  • Method Details

    • appBundleIdentifier

      public final String appBundleIdentifier()

      The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

      Returns:
      The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
    • app

      public final String app()

      The name of the application.

      Valid values are:

      • SLACK

      • ASANA

      • JIRA

      • M365

      • M365AUDITLOGS

      • ZOOM

      • ZENDESK

      • OKTA

      • GOOGLE

      • DROPBOX

      • SMARTSHEET

      • CISCO

      Returns:
      The name of the application.

      Valid values are:

      • SLACK

      • ASANA

      • JIRA

      • M365

      • M365AUDITLOGS

      • ZOOM

      • ZENDESK

      • OKTA

      • GOOGLE

      • DROPBOX

      • SMARTSHEET

      • CISCO

    • tenantId

      public final String tenantId()

      The ID of the application tenant.

      Returns:
      The ID of the application tenant.
    • ingestionType

      public final IngestionType ingestionType()

      The ingestion type.

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

      Returns:
      The ingestion type.
      See Also:
    • ingestionTypeAsString

      public final String ingestionTypeAsString()

      The ingestion type.

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

      Returns:
      The ingestion type.
      See Also:
    • clientToken

      public final String clientToken()

      Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

      If you don't provide this value, then Amazon Web Services generates a random one for you.

      If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

      Returns:
      Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

      If you don't provide this value, then Amazon Web Services generates a random one for you.

      If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

    • 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 map of the key-value pairs of the tag or tags to assign to the resource.

      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 map of the key-value pairs of the tag or tags to assign to the resource.
    • toBuilder

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

      public static CreateIngestionRequest.Builder builder()
    • serializableBuilderClass

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