Package software.amazon.awssdk.services.proton.model

Class CreateServiceRequest

    • Method Detail

      • branchName

        public final String branchName()

        The name of the code repository branch that holds the code that's deployed in Proton. Don't include this parameter if your service template doesn't include a service pipeline.

        Returns:
        The name of the code repository branch that holds the code that's deployed in Proton. Don't include this parameter if your service template doesn't include a service pipeline.

      • description

        public final String description()

        A description of the Proton service.

        Returns:
        A description of the Proton service.

      • name

        public final String name()

        The service name.

        Returns:
        The service name.

      • repositoryConnectionArn

        public final String repositoryConnectionArn()

        The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide. Don't include this parameter if your service template doesn't include a service pipeline.

        Returns:
        The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide. Don't include this parameter if your service template doesn't include a service pipeline.

      • repositoryId

        public final String repositoryId()

        The ID of the code repository. Don't include this parameter if your service template doesn't include a service pipeline.

        Returns:
        The ID of the code repository. Don't include this parameter if your service template doesn't include a service pipeline.

      • spec

        public final String spec()

        A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see Create a service in the Proton User Guide.

        Returns:
        A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see Create a service in the Proton User Guide.

      • 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. 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. A tag is a key-value pair.

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

      • templateMajorVersion

        public final String templateMajorVersion()

        The major version of the service template that was used to create the service.

        Returns:
        The major version of the service template that was used to create the service.

      • templateMinorVersion

        public final String templateMinorVersion()

        The minor version of the service template that was used to create the service.

        Returns:
        The minor version of the service template that was used to create the service.

      • templateName

        public final String templateName()

        The name of the service template that's used to create the service.

        Returns:
        The name of the service template that's used to create the service.

      • 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