Package software.amazon.awssdk.services.codepipeline.model

Class CreateCustomActionTypeRequest

    • Method Detail

      • category

        public final ActionCategory category()

        The category of the custom action, such as a build action or a test action.

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

        Returns:
        The category of the custom action, such as a build action or a test action.
        See Also:
        ActionCategory

      • categoryAsString

        public final String categoryAsString()

        The category of the custom action, such as a build action or a test action.

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

        Returns:
        The category of the custom action, such as a build action or a test action.
        See Also:
        ActionCategory

      • provider

        public final String provider()

        The provider of the service used in the custom action, such as CodeDeploy.

        Returns:
        The provider of the service used in the custom action, such as CodeDeploy.

      • version

        public final String version()

        The version identifier of the custom action.

        Returns:
        The version identifier of the custom action.

      • settings

        public final ActionTypeSettings settings()

        URLs that provide users information about this custom action.

        Returns:
        URLs that provide users information about this custom action.

      • hasConfigurationProperties

        public final boolean hasConfigurationProperties()
        For responses, this returns true if the service returned a value for the ConfigurationProperties 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.

      • configurationProperties

        public final List<ActionConfigurationProperty> configurationProperties()

        The configuration properties for the custom action.

        You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline.

        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 hasConfigurationProperties() method.

        Returns:
        The configuration properties for the custom action.

        You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline.

      • inputArtifactDetails

        public final ArtifactDetails inputArtifactDetails()

        The details of the input artifact for the action, such as its commit ID.

        Returns:
        The details of the input artifact for the action, such as its commit ID.

      • outputArtifactDetails

        public final ArtifactDetails outputArtifactDetails()

        The details of the output artifact of the action, such as its commit ID.

        Returns:
        The details of the output artifact of the action, such as its commit ID.

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

        The tags for the custom action.

        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:
        The tags for the custom action.

      • 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