Class StartImportRequest

    • Method Detail

      • payload

        public final SdkBytes payload()

        A zip archive in binary format. The archive should contain one file, a JSON file containing the resource to import. The resource should match the type specified in the resourceType field.

        Returns:
        A zip archive in binary format. The archive should contain one file, a JSON file containing the resource to import. The resource should match the type specified in the resourceType field.
      • resourceType

        public final ResourceType resourceType()

        Specifies the type of resource to export. Each resource also exports any resources that it depends on.

        • A bot exports dependent intents.

        • An intent exports dependent slot types.

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

        Returns:
        Specifies the type of resource to export. Each resource also exports any resources that it depends on.

        • A bot exports dependent intents.

        • An intent exports dependent slot types.

        See Also:
        ResourceType
      • resourceTypeAsString

        public final String resourceTypeAsString()

        Specifies the type of resource to export. Each resource also exports any resources that it depends on.

        • A bot exports dependent intents.

        • An intent exports dependent slot types.

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

        Returns:
        Specifies the type of resource to export. Each resource also exports any resources that it depends on.

        • A bot exports dependent intents.

        • An intent exports dependent slot types.

        See Also:
        ResourceType
      • mergeStrategy

        public final MergeStrategy mergeStrategy()

        Specifies the action that the StartImport operation should take when there is an existing resource with the same name.

        • FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the failureReason field of the response to the GetImport operation.

          OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file.

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

        Returns:
        Specifies the action that the StartImport operation should take when there is an existing resource with the same name.

        • FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the failureReason field of the response to the GetImport operation.

          OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file.

        See Also:
        MergeStrategy
      • mergeStrategyAsString

        public final String mergeStrategyAsString()

        Specifies the action that the StartImport operation should take when there is an existing resource with the same name.

        • FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the failureReason field of the response to the GetImport operation.

          OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file.

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

        Returns:
        Specifies the action that the StartImport operation should take when there is an existing resource with the same name.

        • FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the failureReason field of the response to the GetImport operation.

          OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file.

        See Also:
        MergeStrategy
      • 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 to add to the imported bot. You can only add tags when you import a bot, you can't add tags to an intent or slot type.

        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 to add to the imported bot. You can only add tags when you import a bot, you can't add tags to an intent or slot type.
      • 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