SshCredentials (Atlassian Bamboo Plan Specs Implementation 9.6.15 API)

java.lang.Object
- com.atlassian.bamboo.specs.api.builders.EntityPropertiesBuilder<T>
- - com.atlassian.bamboo.specs.api.builders.RootEntityPropertiesBuilder<C>
  - - com.atlassian.bamboo.specs.api.builders.credentials.SharedCredentials<SshCredentials,SshCredentialsProperties>
    - - com.atlassian.bamboo.specs.builders.credentials.SshCredentials

```
public class SshCredentials
extends SharedCredentials<SshCredentials,SshCredentialsProperties>
```
Represent shared SSH credentials. Shared SSH credentials can be used when defining authorisation of VCS repositories (e.g. GitRepository) and in certain tasks.

Field Summary
- Fields inherited from class com.atlassian.bamboo.specs.api.builders.credentials.SharedCredentials
  name, oid, project, TYPE

Constructor Summary

Constructors
Constructor Description

SshCredentials()
Create new SSH credentials.

SshCredentials(String name)
Create new SSH credentials with name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected SshCredentialsProperties`	`build()`
`SshCredentials`	`passphrase(String passhphrase)`	Set passphrase to use to access SSH private key.
`SshCredentials`	`privateKey(String key)`	Set SSH private key.

Methods inherited from class com.atlassian.bamboo.specs.api.builders.credentials.SharedCredentials
humanReadableId, humanReadableType, name, oid, oid, project

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SshCredentials
```
public SshCredentials()
```
    Create new SSH credentials.
  - SshCredentials
```
public SshCredentials(String name)
```
    Create new SSH credentials with name.
    
    Parameters:
    
    name - name of the credentials.
- Method Detail
  - privateKey
```
public SshCredentials privateKey(String key)
```
    Set SSH private key.
  - passphrase
```
public SshCredentials passphrase(String passhphrase)
```
    Set passphrase to use to access SSH private key.
  - build
```
protected SshCredentialsProperties build()
```
    Specified by:
    
    build in class SharedCredentials<SshCredentials,SshCredentialsProperties>