Package com.onshape.api.requests

Class AliasesUpdateAliasRequest.Builder

java.lang.Object

com.onshape.api.requests.AliasesUpdateAliasRequest.Builder

Enclosing class:

AliasesUpdateAliasRequest

public static final class AliasesUpdateAliasRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AliasesUpdateAliasRequestAdditions[]	additions()	Get Users/teams to add to the alias (provide one of userId, teamId, email on each)
AliasesUpdateAliasRequest.Builder	additions(AliasesUpdateAliasRequestAdditions[] value)	Set Users/teams to add to the alias (provide one of userId, teamId, email on each)
AliasesUpdateAliasResponse	call(String aid)	Calls updateAlias method, Rename or add/remove identities on an alias in your enterprise.
String	description()	Get New description of the alias
AliasesUpdateAliasRequest.Builder	description(String value)	Set New description of the alias
AliasesUpdateAliasRequestEntries[]	entries()	Get Users/teams to replace the contents of the alias (provide one of userId, teamId, email on each).
AliasesUpdateAliasRequest.Builder	entries(AliasesUpdateAliasRequestEntries[] value)	Set Users/teams to replace the contents of the alias (provide one of userId, teamId, email on each).
String	name()	Get New name of the alias
AliasesUpdateAliasRequest.Builder	name(String value)	Set New name of the alias
AliasesUpdateAliasRequestRemovals[]	removals()	Get Users/teams to remove from the alias (provide one of userId, teamId, email on each)
AliasesUpdateAliasRequest.Builder	removals(AliasesUpdateAliasRequestRemovals[] value)	Set Users/teams to remove from the alias (provide one of userId, teamId, email on each)

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 New name of the alias

Returns:

New name of the alias

name

public final AliasesUpdateAliasRequest.Builder name(String value)

Set New name of the alias

Parameters:

value - New name of the alias

Returns:

the Builder object.

description

public final String description()

Get New description of the alias

Returns:

New description of the alias

description

public final AliasesUpdateAliasRequest.Builder description(String value)

Set New description of the alias

Parameters:

value - New description of the alias

Returns:

the Builder object.

entries

public final AliasesUpdateAliasRequestEntries[] entries()

Get Users/teams to replace the contents of the alias (provide one of userId, teamId, email on each). If provided, additions and removals must be left out.

Returns:

Users/teams to replace the contents of the alias (provide one of userId, teamId, email on each). If provided, additions and removals must be left out.

entries

public final AliasesUpdateAliasRequest.Builder entries(AliasesUpdateAliasRequestEntries[] value)

Set Users/teams to replace the contents of the alias (provide one of userId, teamId, email on each). If provided, additions and removals must be left out.

Parameters:

value - Users/teams to replace the contents of the alias (provide one of userId, teamId, email on each). If provided, additions and removals must be left out.

Returns:

the Builder object.

additions

public final AliasesUpdateAliasRequestAdditions[] additions()

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)

additions

public final AliasesUpdateAliasRequest.Builder additions(AliasesUpdateAliasRequestAdditions[] 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.

removals

public final AliasesUpdateAliasRequestRemovals[] removals()

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

Returns:

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

removals

public final AliasesUpdateAliasRequest.Builder removals(AliasesUpdateAliasRequestRemovals[] value)

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

Parameters:

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

Returns:

the Builder object.

call

public final AliasesUpdateAliasResponse call(String aid)
                                      throws OnshapeException

Calls updateAlias method, Rename or add/remove identities on an alias in your enterprise. You need the "Manage users and teams" global permission for this.

Parameters:

aid - Alias ID to update

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error