Package com.onshape.api.requests

Class AliasesUpdateAliasRequest

java.lang.Object

com.onshape.api.requests.AliasesUpdateAliasRequest

public final class AliasesUpdateAliasRequest
extends Object

Request object for updateAlias API endpoint. © 2018-Present Onshape Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AliasesUpdateAliasRequest.Builder

Method Summary

Modifier and Type	Method	Description
static AliasesUpdateAliasRequest.Builder	builder(Onshape onshape)
AliasesUpdateAliasRequestAdditions[]	getAdditions()	Get Users/teams to add to the alias (provide one of userId, teamId, email on each)
String	getDescription()	Get New description of the alias
AliasesUpdateAliasRequestEntries[]	getEntries()	Get Users/teams to replace the contents of the alias (provide one of userId, teamId, email on each).
String	getName()	Get New name of the alias
AliasesUpdateAliasRequestRemovals[]	getRemovals()	Get Users/teams to remove from the alias (provide one of userId, teamId, email on each)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getName

public final String getName()

Get New name of the alias

Returns:

New name of the alias

getDescription

public final String getDescription()

Get New description of the alias

Returns:

New description of the alias

getEntries

public final AliasesUpdateAliasRequestEntries[] getEntries()

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.

getAdditions

public final AliasesUpdateAliasRequestAdditions[] getAdditions()

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)

getRemovals

public final AliasesUpdateAliasRequestRemovals[] getRemovals()

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)

toString

public String toString()

Overrides:

toString in class Object

builder

public static final AliasesUpdateAliasRequest.Builder builder(Onshape onshape)