Record Class BuilderDockerConfiguration

java.lang.Object

java.lang.Record

org.springframework.boot.buildpack.platform.build.BuilderDockerConfiguration

Record Components:

connection - the Docker host configuration

bindHostToBuilder - if the host resolved from the connection should be bound to the builder

builderRegistryAuthentication - the builder DockerRegistryAuthentication

publishRegistryAuthentication - the publish DockerRegistryAuthentication

public record BuilderDockerConfiguration(@Nullable DockerConnectionConfiguration connection, boolean bindHostToBuilder, @Nullable DockerRegistryAuthentication builderRegistryAuthentication, @Nullable DockerRegistryAuthentication publishRegistryAuthentication)
extends Record

Builder configuration options for Docker.

Since:

3.5.0

Author:

Phillip Webb, Wei Jiang, Scott Frederick

Constructor Summary

Constructors

Constructor	Description
BuilderDockerConfiguration()
BuilderDockerConfiguration(@Nullable DockerConnectionConfiguration connection, boolean bindHostToBuilder, @Nullable DockerRegistryAuthentication builderRegistryAuthentication, @Nullable DockerRegistryAuthentication publishRegistryAuthentication)	Creates an instance of a BuilderDockerConfiguration record class.

Method Summary

Modifier and Type	Method	Description
boolean	bindHostToBuilder()	Returns the value of the bindHostToBuilder record component.
@Nullable DockerRegistryAuthentication	builderRegistryAuthentication()	Returns the value of the builderRegistryAuthentication record component.
@Nullable DockerConnectionConfiguration	connection()	Returns the value of the connection record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@Nullable DockerRegistryAuthentication	publishRegistryAuthentication()	Returns the value of the publishRegistryAuthentication record component.
final String	toString()	Returns a string representation of this record class.
BuilderDockerConfiguration	withBindHostToBuilder(boolean bindHostToBuilder)
BuilderDockerConfiguration	withBuilderRegistryAuthentication(DockerRegistryAuthentication builderRegistryAuthentication)
BuilderDockerConfiguration	withContext(String context)
BuilderDockerConfiguration	withHost(String address, boolean secure, @Nullable String certificatePath)
BuilderDockerConfiguration	withPublishRegistryAuthentication(DockerRegistryAuthentication publishRegistryAuthentication)

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BuilderDockerConfiguration

public BuilderDockerConfiguration()

BuilderDockerConfiguration

public BuilderDockerConfiguration(@Nullable DockerConnectionConfiguration connection,
 boolean bindHostToBuilder,
 @Nullable DockerRegistryAuthentication builderRegistryAuthentication,
 @Nullable DockerRegistryAuthentication publishRegistryAuthentication)

Creates an instance of a BuilderDockerConfiguration record class.

Parameters:

connection - the value for the connection record component

bindHostToBuilder - the value for the bindHostToBuilder record component

builderRegistryAuthentication - the value for the builderRegistryAuthentication record component

publishRegistryAuthentication - the value for the publishRegistryAuthentication record component

Method Details

withContext

public BuilderDockerConfiguration withContext(String context)

withHost

public BuilderDockerConfiguration withHost(String address,
 boolean secure,
 @Nullable String certificatePath)

withBindHostToBuilder

public BuilderDockerConfiguration withBindHostToBuilder(boolean bindHostToBuilder)

withBuilderRegistryAuthentication

public BuilderDockerConfiguration withBuilderRegistryAuthentication(DockerRegistryAuthentication builderRegistryAuthentication)

withPublishRegistryAuthentication

public BuilderDockerConfiguration withPublishRegistryAuthentication(DockerRegistryAuthentication publishRegistryAuthentication)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

connection

public @Nullable DockerConnectionConfiguration connection()

Returns the value of the connection record component.

Returns:

the value of the connection record component

bindHostToBuilder

public boolean bindHostToBuilder()

Returns the value of the bindHostToBuilder record component.

Returns:

the value of the bindHostToBuilder record component

builderRegistryAuthentication

public @Nullable DockerRegistryAuthentication builderRegistryAuthentication()

Returns the value of the builderRegistryAuthentication record component.

Returns:

the value of the builderRegistryAuthentication record component

publishRegistryAuthentication

public @Nullable DockerRegistryAuthentication publishRegistryAuthentication()

Returns the value of the publishRegistryAuthentication record component.

Returns:

the value of the publishRegistryAuthentication record component