com.atlassian.bamboo.specs.api.builders.credentials

Class SharedCredentialsIdentifier

java.lang.Object

com.atlassian.bamboo.specs.api.builders.EntityPropertiesBuilder<SharedCredentialsIdentifierProperties>

com.atlassian.bamboo.specs.api.builders.credentials.SharedCredentialsIdentifier

public class SharedCredentialsIdentifier
extends EntityPropertiesBuilder<SharedCredentialsIdentifierProperties>

References a shared credential.

Constructor Summary

Constructors

Constructor and Description
SharedCredentialsIdentifier(BambooOid oid) Reference shared credential by oid.
SharedCredentialsIdentifier(String name) Reference shared credential by name.

Method Summary

Modifier and Type	Method and Description
protected SharedCredentialsIdentifierProperties	build()
SharedCredentialsIdentifier	name(String name) Reference shared credential by name.
SharedCredentialsIdentifier	oid(BambooOid oid) Reference shared credential by oid.
SharedCredentialsIdentifier	oid(String oid) Reference shared credential by oid.
SharedCredentialsIdentifier	scope(SharedCredentialsScope scope) Set scope for shared credentials.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SharedCredentialsIdentifier

public SharedCredentialsIdentifier(@NotNull
                                   String name)
                            throws PropertiesValidationException

Reference shared credential by name. Name of the credential is ignored if oid is defined.

Throws:

PropertiesValidationException

SharedCredentialsIdentifier

public SharedCredentialsIdentifier(@NotNull
                                   BambooOid oid)
                            throws PropertiesValidationException

Reference shared credential by oid.

Throws:

PropertiesValidationException

Method Detail

name

public SharedCredentialsIdentifier name(@NotNull
                                        String name)
                                 throws PropertiesValidationException

Reference shared credential by name. Name of the credential is ignored if oid is defined.

Throws:

PropertiesValidationException

oid

public SharedCredentialsIdentifier oid(@NotNull
                                       String oid)
                                throws PropertiesValidationException

Reference shared credential by oid.

Throws:

PropertiesValidationException

oid

public SharedCredentialsIdentifier oid(@NotNull
                                       BambooOid oid)
                                throws PropertiesValidationException

Reference shared credential by oid. Scope of shared credentials must matches, i.e. if shared credentials belongs to project then the scope SharedCredentialsScope.PROJECT must be set.

Throws:

PropertiesValidationException

scope

public SharedCredentialsIdentifier scope(@NotNull
                                         SharedCredentialsScope scope)
                                  throws PropertiesValidationException

Set scope for shared credentials. Default is SharedCredentialsScope.GLOBAL.

Throws:

PropertiesValidationException

build

protected SharedCredentialsIdentifierProperties build()
                                               throws PropertiesValidationException

Specified by:

build in class EntityPropertiesBuilder<SharedCredentialsIdentifierProperties>

Throws:

PropertiesValidationException