HookSecretConfig (GitHub plugin 1.39.0 API)

java.lang.Object
- hudson.model.AbstractDescribableImpl<HookSecretConfig>
- - org.jenkinsci.plugins.github.config.HookSecretConfig

All Implemented Interfaces:

Describable<HookSecretConfig>
```
public class HookSecretConfig
extends AbstractDescribableImpl<HookSecretConfig>
```
Manages storing/retrieval of the shared secret for the hook.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class HookSecretConfig.DescriptorImpl

Constructor Summary

Constructors
Constructor Description

HookSecretConfig(String credentialsId)

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`String`	`getCredentialsId()`
`Secret`	`getHookSecret()`	Gets the currently used secret being used for payload verification.
`void`	`setCredentialsId(String credentialsId)`	Deprecated. rather treat this field as final and use `GitHubPluginConfig.setHookSecretConfigs(java.util.List<org.jenkinsci.plugins.github.config.HookSecretConfig>)`

Methods inherited from class hudson.model.AbstractDescribableImpl
getDescriptor

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

- Constructor Detail
  - HookSecretConfig
```
@DataBoundConstructor
public HookSecretConfig(String credentialsId)
```
- Method Detail
  - getHookSecret
```
@Nullable
public Secret getHookSecret()
```
    Gets the currently used secret being used for payload verification.
    
    Returns:
    
    Current secret, null if not set.
  - getCredentialsId
```
public String getCredentialsId()
```
  - setCredentialsId
```
@Deprecated
public void setCredentialsId(String credentialsId)
```
    Deprecated.
    rather treat this field as final and use GitHubPluginConfig.setHookSecretConfigs(java.util.List<org.jenkinsci.plugins.github.config.HookSecretConfig>)
    
    Parameters:
    
    credentialsId - a new ID