DockerRegistryCredentials (gradle-docker-plugin 9.0.1 API)

com.bmuschko.gradle.docker.DockerRegistryCredentials

```
@CompileStatic
class DockerRegistryCredentials
extends Object
```
The extension for configuring the Docker communication via the remote API through the DockerRemoteApiPlugin.
The following example demonstrates the use of the extension in a build script using the Groovy DSL:
```
 docker {
     registryCredentials {
         username = 'bmuschko'
         password = 'pwd'
     }
 }
 
```

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`DockerRegistryCredentials.1`

Field Summary

Fields
Modifiers	Name	Description
`static String`	`DEFAULT_URL`	The registry URL used as default value for the property url.

Properties Summary

Properties
Type	Name and description
`Property<String>`	`email` Registry email address needed to push images.
`Property<String>`	`password` Registry password needed to push images.
`Property<String>`	`url` Registry URL needed to push images.
`Property<String>`	`username` Registry username needed to push images.

Constructor Summary

Constructors
Constructor and description
`DockerRegistryCredentials (ObjectFactory objectFactory)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`PasswordCredentials`	`asPasswordCredentials()` Translates the Docker registry credentials into a PasswordCredentials.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - public static final String DEFAULT_URL
    
    The registry URL used as default value for the property url.
- Property Detail
  - @Input @Optional final Property<String> email
    
    Registry email address needed to push images.
    Defaults to null.
  - @Input @Optional final Property<String> password
    
    Registry password needed to push images.
    Defaults to null.
  - @Input final Property<String> url
    
    Registry URL needed to push images.
    Defaults to "https://index.docker.io/v1/".
  - @Input @Optional final Property<String> username
    
    Registry username needed to push images.
    Defaults to null.
- Constructor Detail
  - @Inject DockerRegistryCredentials(ObjectFactory objectFactory)
- Method Detail
  - PasswordCredentials asPasswordCredentials()
    
    Translates the Docker registry credentials into a PasswordCredentials.
    Since:
    4.0.0

Groovy Documentation