org.springframework.credhub.support.user

Class UserParametersRequest.UserParametersRequestBuilder

java.lang.Object

org.springframework.credhub.support.CredHubRequest.CredHubRequestBuilder<PasswordParameters,UserParametersRequest,UserParametersRequest.UserParametersRequestBuilder>

org.springframework.credhub.support.user.UserParametersRequest.UserParametersRequestBuilder

Enclosing class:

UserParametersRequest

public static class UserParametersRequest.UserParametersRequestBuilder
extends CredHubRequest.CredHubRequestBuilder<PasswordParameters,UserParametersRequest,UserParametersRequest.UserParametersRequestBuilder>

A builder that provides a fluent API for constructing UserParametersRequests.

Field Summary

Fields inherited from class org.springframework.credhub.support.CredHubRequest.CredHubRequestBuilder

targetObj

Constructor Summary

Constructors

Constructor and Description
UserParametersRequestBuilder()

Method Summary

Modifier and Type	Method and Description
protected UserParametersRequest.UserParametersRequestBuilder	createBuilder() Provide the concrete builder.
protected UserParametersRequest	createTarget() Provide the concrete object to build.
UserParametersRequest.UserParametersRequestBuilder	parameters(PasswordParameters parameters) Set the parameters for generation of the password for a user credential.
UserParametersRequest.UserParametersRequestBuilder	username(String username) Set the username for the generated user.

Methods inherited from class org.springframework.credhub.support.CredHubRequest.CredHubRequestBuilder

build, mode, name, overwrite, permission, permissions, permissions

Methods inherited from class java.lang.Object

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

Constructor Detail

UserParametersRequestBuilder

public UserParametersRequestBuilder()

Method Detail

createTarget

protected UserParametersRequest createTarget()

Description copied from class: CredHubRequest.CredHubRequestBuilder

Provide the concrete object to build.

Specified by:

createTarget in class CredHubRequest.CredHubRequestBuilder<PasswordParameters,UserParametersRequest,UserParametersRequest.UserParametersRequestBuilder>

Returns:

the target object

createBuilder

protected UserParametersRequest.UserParametersRequestBuilder createBuilder()

Description copied from class: CredHubRequest.CredHubRequestBuilder

Provide the concrete builder.

Specified by:

createBuilder in class CredHubRequest.CredHubRequestBuilder<PasswordParameters,UserParametersRequest,UserParametersRequest.UserParametersRequestBuilder>

Returns:

the builder

parameters

public UserParametersRequest.UserParametersRequestBuilder parameters(PasswordParameters parameters)

Set the parameters for generation of the password for a user credential.

Parameters:

parameters - the password generation parameters; must not be null

Returns:

the builder

username

public UserParametersRequest.UserParametersRequestBuilder username(String username)

Set the username for the generated user.

Parameters:

username - the username; must not be null

Returns:

the builder