SwitchingToVmcModeParameters.Builder (Java SDK for NSX Manager API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx.model.SwitchingToVmcModeParameters.Builder

Enclosing class:

SwitchingToVmcModeParameters
```
public static final class SwitchingToVmcModeParameters.Builder
extends java.lang.Object
```
Builder class for SwitchingToVmcModeParameters.

Constructor Summary

Constructors
Constructor and Description

Builder()
Constructor with parameters for the required properties of SwitchingToVmcModeParameters.

Constructors
Constructor and Description
`Builder()` Constructor with parameters for the required properties of `SwitchingToVmcModeParameters`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SwitchingToVmcModeParameters`	`build()`
`SwitchingToVmcModeParameters.Builder`	`setAuthCode(Oauth2Credentials authCode)`
`SwitchingToVmcModeParameters.Builder`	`setBaseUrl(java.lang.String baseUrl)` Protocol and domain name (or IP address) of a CSP server, like \"https://console-stg.cloud.vmware.com\".
`SwitchingToVmcModeParameters.Builder`	`setBasicAuthWhitelistIps(java.util.List<java.lang.String> basicAuthWhitelistIps)` List of whitelist IPs for basic auth
`SwitchingToVmcModeParameters.Builder`	`setCspAccessTokenUri(java.lang.String cspAccessTokenUri)` This CSP end-point exchanges one of the following grants - authorization_code, refresh_token, client_credentials or client_delegate for an access token.
`SwitchingToVmcModeParameters.Builder`	`setCspClientCredential(Oauth2Credentials cspClientCredential)`
`SwitchingToVmcModeParameters.Builder`	`setCspClientIncomingCredentials(java.util.List<java.lang.String> cspClientIncomingCredentials)` List of incoming client IDs
`SwitchingToVmcModeParameters.Builder`	`setCspLogoutUri(java.lang.String cspLogoutUri)` This CSP end-point returns the identity provider's logout url.
`SwitchingToVmcModeParameters.Builder`	`setCspOrgUri(java.lang.String cspOrgUri)` Relative path on CSP server to the Org location.
`SwitchingToVmcModeParameters.Builder`	`setCspPublicKeyUri(java.lang.String cspPublicKeyUri)` CSP endpoint that returns a list of public keys in jwks format.
`SwitchingToVmcModeParameters.Builder`	`setCspTimeDrift(java.lang.Long cspTimeDrift)` CSP time drift in milliseconds format: int64
`SwitchingToVmcModeParameters.Builder`	`setCspUserAuthorizationUri(java.lang.String cspUserAuthorizationUri)` This endpoint is used with browser redirection only.
`SwitchingToVmcModeParameters.Builder`	`setCspUserInfoUri(java.lang.String cspUserInfoUri)` This endpoint returns the content of the given access token if the token is valid.
`SwitchingToVmcModeParameters.Builder`	`setDefaultOrgId(java.lang.String defaultOrgId)` Org ID of a Client - commonly UUID.
`SwitchingToVmcModeParameters.Builder`	`setEaOrg(OrgInfo eaOrg)`
`SwitchingToVmcModeParameters.Builder`	`setGssOrg(OrgInfo gssOrg)`
`SwitchingToVmcModeParameters.Builder`	`setModeChangeOnly(java.lang.Boolean modeChangeOnly)` When this parameter is set to true, only a change of the node mode happens without any update to the auth properties.
`SwitchingToVmcModeParameters.Builder`	`setModeId(java.lang.String modeId)` Possible values are: `SwitchingToVmcModeParameters.MODE_ID_ON_PREM` `SwitchingToVmcModeParameters.MODE_ID_SERVICE` `SwitchingToVmcModeParameters.MODE_ID_VMC` `SwitchingToVmcModeParameters.MODE_ID_VMC_LOCAL` Possible enum values in a \"/config/nsx_appliance_mode\" file
`SwitchingToVmcModeParameters.Builder`	`setProxyHost(java.lang.String proxyHost)` IP/host of PoP (Point-of-Presence) HTTP proxy server format: hostname-or-ip
`SwitchingToVmcModeParameters.Builder`	`setProxyPort(java.lang.Long proxyPort)` Port of PoP (Point-of-Presence) Http proxy server format: int64
`SwitchingToVmcModeParameters.Builder`	`setPublicClientInfo(PublicClientInfo publicClientInfo)`
`SwitchingToVmcModeParameters.Builder`	`setResourceType(java.lang.String resourceType)` Possible values are: `SwitchingToVmcModeParameters.RESOURCE_TYPE_SWITCHINGTOVMCMODEPARAMETERS` Node Mode type
`SwitchingToVmcModeParameters.Builder`	`setSaasCspClientCredential(Oauth2Credentials saasCspClientCredential)`
`SwitchingToVmcModeParameters.Builder`	`setSaasServiceUrl(java.lang.String saasServiceUrl)` Protocol and domain name (or IP address) of a SAAS server, like \"https://stg.skyscraper.vmware.com\".
`SwitchingToVmcModeParameters.Builder`	`setSddcId(java.lang.String sddcId)` SDDC id
`SwitchingToVmcModeParameters.Builder`	`setServiceDefinitionId(java.lang.String serviceDefinitionId)` Service definition id
`SwitchingToVmcModeParameters.Builder`	`setSreOrg(OrgInfo sreOrg)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
    Constructor with parameters for the required properties of SwitchingToVmcModeParameters.
- Method Detail
  - setModeId
```
public SwitchingToVmcModeParameters.Builder setModeId(java.lang.String modeId)
```
    Possible values are:
    Possible enum values in a \"/config/nsx_appliance_mode\" file
    Parameters:
    
    modeId - New value for the property.
  - setAuthCode
```
public SwitchingToVmcModeParameters.Builder setAuthCode(Oauth2Credentials authCode)
```
    Parameters:
    
    authCode - New value for the property.
  - setBaseUrl
```
public SwitchingToVmcModeParameters.Builder setBaseUrl(java.lang.String baseUrl)
```
    Protocol and domain name (or IP address) of a CSP server, like \"https://console-stg.cloud.vmware.com\".
    
    Parameters:
    
    baseUrl - New value for the property.
  - setBasicAuthWhitelistIps
```
public SwitchingToVmcModeParameters.Builder setBasicAuthWhitelistIps(java.util.List<java.lang.String> basicAuthWhitelistIps)
```
    List of whitelist IPs for basic auth
    
    Parameters:
    
    basicAuthWhitelistIps - New value for the property.
  - setCspAccessTokenUri
```
public SwitchingToVmcModeParameters.Builder setCspAccessTokenUri(java.lang.String cspAccessTokenUri)
```
    This CSP end-point exchanges one of the following grants - authorization_code, refresh_token, client_credentials or client_delegate for an access token.
    
    Parameters:
    
    cspAccessTokenUri - New value for the property.
  - setCspClientCredential
```
public SwitchingToVmcModeParameters.Builder setCspClientCredential(Oauth2Credentials cspClientCredential)
```
    Parameters:
    
    cspClientCredential - New value for the property.
  - setCspClientIncomingCredentials
```
public SwitchingToVmcModeParameters.Builder setCspClientIncomingCredentials(java.util.List<java.lang.String> cspClientIncomingCredentials)
```
    List of incoming client IDs
    
    Parameters:
    
    cspClientIncomingCredentials - New value for the property.
  - setCspLogoutUri
```
public SwitchingToVmcModeParameters.Builder setCspLogoutUri(java.lang.String cspLogoutUri)
```
    This CSP end-point returns the identity provider's logout url. In order to logout, an explicit redirect to this url is needed.
    
    Parameters:
    
    cspLogoutUri - New value for the property.
  - setCspOrgUri
```
public SwitchingToVmcModeParameters.Builder setCspOrgUri(java.lang.String cspOrgUri)
```
    Relative path on CSP server to the Org location. Can be \"/csp/gateway/am/api/orgs/\".
    
    Parameters:
    
    cspOrgUri - New value for the property.
  - setCspPublicKeyUri
```
public SwitchingToVmcModeParameters.Builder setCspPublicKeyUri(java.lang.String cspPublicKeyUri)
```
    CSP endpoint that returns a list of public keys in jwks format. These keys are used in an application to validate that the access-token is valid.
    
    Parameters:
    
    cspPublicKeyUri - New value for the property.
  - setCspTimeDrift
```
public SwitchingToVmcModeParameters.Builder setCspTimeDrift(java.lang.Long cspTimeDrift)
```
    CSP time drift in milliseconds format: int64
    
    Parameters:
    
    cspTimeDrift - New value for the property.
  - setCspUserAuthorizationUri
```
public SwitchingToVmcModeParameters.Builder setCspUserAuthorizationUri(java.lang.String cspUserAuthorizationUri)
```
    This endpoint is used with browser redirection only. It discovers the user's Identity Provider (IdP) and sends the user to the IdP login page. It is the starting point of the OAuth 2.0 flow to authenticate end users from an application.
    
    Parameters:
    
    cspUserAuthorizationUri - New value for the property.
  - setCspUserInfoUri
```
public SwitchingToVmcModeParameters.Builder setCspUserInfoUri(java.lang.String cspUserInfoUri)
```
    This endpoint returns the content of the given access token if the token is valid. It also includes the group_ids and group_names if the client is registered with group_id, group_names scopes. It's usually /am/api/userinfo.
    
    Parameters:
    
    cspUserInfoUri - New value for the property.
  - setDefaultOrgId
```
public SwitchingToVmcModeParameters.Builder setDefaultOrgId(java.lang.String defaultOrgId)
```
    Org ID of a Client - commonly UUID.
    
    Parameters:
    
    defaultOrgId - New value for the property.
  - setEaOrg
```
public SwitchingToVmcModeParameters.Builder setEaOrg(OrgInfo eaOrg)
```
    Parameters:
    
    eaOrg - New value for the property.
  - setGssOrg
```
public SwitchingToVmcModeParameters.Builder setGssOrg(OrgInfo gssOrg)
```
    Parameters:
    
    gssOrg - New value for the property.
  - setModeChangeOnly
```
public SwitchingToVmcModeParameters.Builder setModeChangeOnly(java.lang.Boolean modeChangeOnly)
```
    When this parameter is set to true, only a change of the node mode happens without any update to the auth properties. When this param is not set to true i.e. set to false or not provided, mode change and update to the auth properties will both happen.
    
    Parameters:
    
    modeChangeOnly - New value for the property.
  - setProxyHost
```
public SwitchingToVmcModeParameters.Builder setProxyHost(java.lang.String proxyHost)
```
    IP/host of PoP (Point-of-Presence) HTTP proxy server format: hostname-or-ip
    
    Parameters:
    
    proxyHost - New value for the property.
  - setProxyPort
```
public SwitchingToVmcModeParameters.Builder setProxyPort(java.lang.Long proxyPort)
```
    Port of PoP (Point-of-Presence) Http proxy server format: int64
    
    Parameters:
    
    proxyPort - New value for the property.
  - setPublicClientInfo
```
public SwitchingToVmcModeParameters.Builder setPublicClientInfo(PublicClientInfo publicClientInfo)
```
    Parameters:
    
    publicClientInfo - New value for the property.
  - setResourceType
```
public SwitchingToVmcModeParameters.Builder setResourceType(java.lang.String resourceType)
```
    Possible values are:
    - SwitchingToVmcModeParameters.RESOURCE_TYPE_SWITCHINGTOVMCMODEPARAMETERS
    Node Mode type
    Parameters:
    
    resourceType - New value for the property.
  - setSaasCspClientCredential
```
public SwitchingToVmcModeParameters.Builder setSaasCspClientCredential(Oauth2Credentials saasCspClientCredential)
```
    Parameters:
    
    saasCspClientCredential - New value for the property.
  - setSaasServiceUrl
```
public SwitchingToVmcModeParameters.Builder setSaasServiceUrl(java.lang.String saasServiceUrl)
```
    Protocol and domain name (or IP address) of a SAAS server, like \"https://stg.skyscraper.vmware.com\".
    
    Parameters:
    
    saasServiceUrl - New value for the property.
  - setSddcId
```
public SwitchingToVmcModeParameters.Builder setSddcId(java.lang.String sddcId)
```
    SDDC id
    
    Parameters:
    
    sddcId - New value for the property.
  - setServiceDefinitionId
```
public SwitchingToVmcModeParameters.Builder setServiceDefinitionId(java.lang.String serviceDefinitionId)
```
    Service definition id
    
    Parameters:
    
    serviceDefinitionId - New value for the property.
  - setSreOrg
```
public SwitchingToVmcModeParameters.Builder setSreOrg(OrgInfo sreOrg)
```
    Parameters:
    
    sreOrg - New value for the property.
  - build
```
public SwitchingToVmcModeParameters build()
```

Class SwitchingToVmcModeParameters.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

setModeId

setAuthCode

setBaseUrl

setBasicAuthWhitelistIps

setCspAccessTokenUri

setCspClientCredential

setCspClientIncomingCredentials

setCspLogoutUri

setCspOrgUri

setCspPublicKeyUri

setCspTimeDrift

setCspUserAuthorizationUri

setCspUserInfoUri

setDefaultOrgId

setEaOrg

setGssOrg

setModeChangeOnly

setProxyHost

setProxyPort

setPublicClientInfo

setResourceType

setSaasCspClientCredential

setSaasServiceUrl

setSddcId

setServiceDefinitionId

setSreOrg

build