Package com.onshape.api.requests

Class AliasesCreateAliasRequest.Builder

java.lang.Object

com.onshape.api.requests.AliasesCreateAliasRequest.Builder

Enclosing class:

AliasesCreateAliasRequest

public static final class AliasesCreateAliasRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AliasesCreateAliasResponse	call()	Calls createAlias method, Create an alias in your enterprise.
String	description()	Get Description of the alias
AliasesCreateAliasRequest.Builder	description(String value)	Set Description of the alias
AliasesCreateAliasRequestEntries[]	entries()	Get Users/teams to add to the alias (provide one of userId, teamId, email on each)
AliasesCreateAliasRequest.Builder	entries(AliasesCreateAliasRequestEntries[] value)	Set Users/teams to add to the alias (provide one of userId, teamId, email on each)
String	name()	Get Name of the alias (required)
AliasesCreateAliasRequest.Builder	name(String value)	Set Name of the alias (required)

Methods inherited from class java.lang.Object

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

Method Detail

name

public final String name()

Get Name of the alias (required)

Returns:

Name of the alias (required)

name

public final AliasesCreateAliasRequest.Builder name(String value)

Set Name of the alias (required)

Parameters:

value - Name of the alias (required)

Returns:

the Builder object.

description

public final String description()

Get Description of the alias

Returns:

Description of the alias

description

public final AliasesCreateAliasRequest.Builder description(String value)

Set Description of the alias

Parameters:

value - Description of the alias

Returns:

the Builder object.

entries

public final AliasesCreateAliasRequestEntries[] entries()

Get Users/teams to add to the alias (provide one of userId, teamId, email on each)

Returns:

Users/teams to add to the alias (provide one of userId, teamId, email on each)

entries

public final AliasesCreateAliasRequest.Builder entries(AliasesCreateAliasRequestEntries[] value)

Set Users/teams to add to the alias (provide one of userId, teamId, email on each)

Parameters:

value - Users/teams to add to the alias (provide one of userId, teamId, email on each)

Returns:

the Builder object.

call

public final AliasesCreateAliasResponse call()
                                      throws OnshapeException

Calls createAlias method, Create an alias in your enterprise. You need the "Manage users and teams" global permission for this.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error