ViPRCoreClient (client 3.5.0.0 API)

java.lang.Object
- com.emc.vipr.client.ViPRCoreClient

public class ViPRCoreClient
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description
`ViPRCoreClient()`
`ViPRCoreClient(ClientConfig config)`
`ViPRCoreClient(java.lang.String host)` Convenience method for calling constructor with new ClientConfig().withHost(host)
`ViPRCoreClient(java.lang.String host, boolean ignoreCertificates)` Convenience method for calling constructor with new ClientConfig().withHost(host).withIgnoringCertificates(ignoreCertificates)

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ApplicationSupport`	`application()`
`Audit`	`audit()`
`AuthClient`	`auth()`
`AuthnProviders`	`authnProviders()`
`AutoTieringPolicies`	`autoTierPolicies()`
`BlockConsistencyGroups`	`blockConsistencyGroups()`
`BlockExports`	`blockExports()`
`BlockFullCopies`	`blockFullCopies()`
`BlockMigrations`	`blockMigrations()`
`BlockSnapshots`	`blockSnapshots()`
`BlockSnapshotSessions`	`blockSnapshotSessions()`
`BlockVolumes`	`blockVolumes()`
`BlockVirtualPools`	`blockVpools()`
`Clusters`	`clusters()`
`ComputeElements`	`computeElements()`
`ComputeImages`	`computeImages()`
`ComputeImageServers`	`computeImageServers()`
`ComputeSystems`	`computeSystems()`
`ComputeVirtualPools`	`computeVpools()`
`CustomConfigs`	`customConfigs()`
`Events`	`events()`
`FileSnapshots`	`fileSnapshots()`
`FileSystems`	`fileSystems()`
`FileVirtualPools`	`fileVpools()`
`UserGroup`	`getUserGroup()`
`UserInfo`	`getUserInfo()`
`TenantResponse`	`getUserTenant()`
`java.net.URI`	`getUserTenantId()`
`Hosts`	`hosts()`
`Initiators`	`initiators()`
`IpInterfaces`	`ipInterfaces()`
`IPsec`	`ipsec()`
`Keystore`	`keystore()`
`Metering`	`metering()`
`Monitoring`	`monitoring()`
`Networks`	`networks()`
`NetworkSystems`	`networkSystems()`
`ObjectBuckets`	`objectBuckets()`
`ObjectNamespaces`	`objectNamespace()`
`ObjectVirtualPools`	`objectVpools()`
`OpenStackTenants`	`openStackTenants()`
`Projects`	`projects()`
`ProtectionSystems`	`protectionSystems()`
`QuotaDirectories`	`quotaDirectories()`
`SchedulePolicies`	`schedulePolicies()`
`void`	`setAuthToken(java.lang.String authToken)` Sets the authentication token to be used for this client.
`void`	`setProxyToken(java.lang.String proxyToken)` Sets the proxy token to be used for this client.
`Site`	`site()`
`StorageProviders`	`smisProviders()` Deprecated.
`StoragePools`	`storagePools()`
`StoragePorts`	`storagePorts()`
`StorageProviders`	`storageProviders()`
`StorageSystems`	`storageSystems()`
`StorageSystemType`	`storageSystemType()`
`StorageTiers`	`storageTiers()`
`TasksResources`	`tasks()`
`Tenants`	`tenants()`
`Truststore`	`truststore()`
`UnManagedCGs`	`unmanagedCGs()`
`UnManagedExportMasks`	`unmanagedExports()`
`UnManagedFileSystems`	`unmanagedFileSystems()`
`UnManagedVolumes`	`unmanagedVolumes()`
`VirtualArrays`	`varrays()`
`VcenterDataCenters`	`vcenterDataCenters()`
`Vcenters`	`vcenters()`
`VirtualDataCenter`	`vdc()`
`VirtualDataCenters`	`vdcs()`
`VirtualNasServers`	`virtualNasServers()`
`ViPRCoreClient`	`withAuthToken(java.lang.String token)` Sets the authentication token and returns the updated client.
`ViPRCoreClient`	`withLogin(java.lang.String username, java.lang.String password)` Performs an authentication login and returns the updated client.
`ViPRCoreClient`	`withProxyToken(java.lang.String token)` Sets the proxy token and returns the updated client.
`Workflows`	`workflows()`

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

Constructor Detail
- ViPRCoreClient
```
public ViPRCoreClient()
```
- ViPRCoreClient
```
public ViPRCoreClient(java.lang.String host)
```
  Convenience method for calling constructor with new ClientConfig().withHost(host)
  
  Parameters:
  
  host - Hostname or IP address for the Virtual IP of the target environment.
- ViPRCoreClient
```
public ViPRCoreClient(java.lang.String host,
                      boolean ignoreCertificates)
```
  Convenience method for calling constructor with new ClientConfig().withHost(host).withIgnoringCertificates(ignoreCertificates)
  
  Parameters:
  
  host - Hostname or IP address for the Virtual IP of the target environment.
  
  ignoreCertificates - True if SSL certificates should be ignored.
- ViPRCoreClient
```
public ViPRCoreClient(ClientConfig config)
```

Method Detail

setAuthToken
```
public void setAuthToken(java.lang.String authToken)
```
Sets the authentication token to be used for this client.

Parameters:

authToken - The authentication token to set.

setProxyToken
```
public void setProxyToken(java.lang.String proxyToken)
```
Sets the proxy token to be used for this client.

Parameters:

proxyToken - The authentication token to set.

auth
```
public AuthClient auth()
```

withLogin
```
public ViPRCoreClient withLogin(java.lang.String username,
                                java.lang.String password)
```
Performs an authentication login and returns the updated client.

Parameters:

username - The username.

password - The password.

Returns:

The updated client.

See Also:

AuthClient.login(String, String)

withAuthToken
```
public ViPRCoreClient withAuthToken(java.lang.String token)
```
Sets the authentication token and returns the updated client.

Parameters:

token - The authentication token to set.

Returns:

The updated client.

See Also:

setAuthToken(String)

withProxyToken
```
public ViPRCoreClient withProxyToken(java.lang.String token)
```
Sets the proxy token and returns the updated client.

Parameters:

token - The proxy token to set.

Returns:

The updated client.

See Also:

setProxyToken(String)

getUserTenant
```
public TenantResponse getUserTenant()
```

getUserTenantId
```
public java.net.URI getUserTenantId()
```

getUserInfo
```
public UserInfo getUserInfo()
```

projects
```
public Projects projects()
```

vdcs
```
public VirtualDataCenters vdcs()
```

events
```
public Events events()
```

hosts
```
public Hosts hosts()
```

clusters
```
public Clusters clusters()
```

vcenters
```
public Vcenters vcenters()
```

vcenterDataCenters

public VcenterDataCenters vcenterDataCenters()

initiators
```
public Initiators initiators()
```

ipInterfaces
```
public IpInterfaces ipInterfaces()
```

blockVolumes
```
public BlockVolumes blockVolumes()
```

blockFullCopies

public BlockFullCopies blockFullCopies()

blockExports
```
public BlockExports blockExports()
```

blockVpools

public BlockVirtualPools blockVpools()

fileVpools
```
public FileVirtualPools fileVpools()
```

objectVpools

public ObjectVirtualPools objectVpools()

objectBuckets
```
public ObjectBuckets objectBuckets()
```

computeVpools

public ComputeVirtualPools computeVpools()

computeImageServers

public ComputeImageServers computeImageServers()

computeImages
```
public ComputeImages computeImages()
```

varrays
```
public VirtualArrays varrays()
```

blockConsistencyGroups

public BlockConsistencyGroups blockConsistencyGroups()

blockMigrations

public BlockMigrations blockMigrations()

blockSnapshots

public BlockSnapshots blockSnapshots()

blockSnapshotSessions

public BlockSnapshotSessions blockSnapshotSessions()

fileSystems
```
public FileSystems fileSystems()
```

quotaDirectories

public QuotaDirectories quotaDirectories()

fileSnapshots
```
public FileSnapshots fileSnapshots()
```

networks
```
public Networks networks()
```

networkSystems

public NetworkSystems networkSystems()

protectionSystems

public ProtectionSystems protectionSystems()

smisProviders

@Deprecated
public StorageProviders smisProviders()

Deprecated.

storageProviders

public StorageProviders storageProviders()

storagePools
```
public StoragePools storagePools()
```

openStackTenants

public OpenStackTenants openStackTenants()

storagePorts
```
public StoragePorts storagePorts()
```

storageSystems

public StorageSystems storageSystems()

virtualNasServers

public VirtualNasServers virtualNasServers()

storageTiers
```
public StorageTiers storageTiers()
```

unmanagedFileSystems

public UnManagedFileSystems unmanagedFileSystems()

unmanagedVolumes

public UnManagedVolumes unmanagedVolumes()

unmanagedCGs
```
public UnManagedCGs unmanagedCGs()
```

unmanagedExports

public UnManagedExportMasks unmanagedExports()

authnProviders

public AuthnProviders authnProviders()

autoTierPolicies

public AutoTieringPolicies autoTierPolicies()

tenants
```
public Tenants tenants()
```

workflows
```
public Workflows workflows()
```

vdc
```
public VirtualDataCenter vdc()
```

audit
```
public Audit audit()
```

monitoring
```
public Monitoring monitoring()
```

metering
```
public Metering metering()
```

computeSystems

public ComputeSystems computeSystems()

computeElements

public ComputeElements computeElements()

keystore
```
public Keystore keystore()
```

truststore
```
public Truststore truststore()
```

tasks
```
public TasksResources tasks()
```

customConfigs
```
public CustomConfigs customConfigs()
```

getUserGroup
```
public UserGroup getUserGroup()
```

site
```
public Site site()
```

ipsec
```
public IPsec ipsec()
```

schedulePolicies

public SchedulePolicies schedulePolicies()

application

public ApplicationSupport application()

objectNamespace

public ObjectNamespaces objectNamespace()

storageSystemType

public StorageSystemType storageSystemType()

Class ViPRCoreClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ViPRCoreClient

ViPRCoreClient

ViPRCoreClient

ViPRCoreClient

Method Detail

setAuthToken

setProxyToken

auth

withLogin

withAuthToken

withProxyToken

getUserTenant

getUserTenantId

getUserInfo

projects

vdcs

events

hosts

clusters

vcenters

vcenterDataCenters

initiators

ipInterfaces

blockVolumes

blockFullCopies

blockExports

blockVpools

fileVpools

objectVpools

objectBuckets

computeVpools

computeImageServers

computeImages

varrays

blockConsistencyGroups

blockMigrations

blockSnapshots

blockSnapshotSessions

fileSystems

quotaDirectories

fileSnapshots

networks

networkSystems

protectionSystems

smisProviders

storageProviders

storagePools

openStackTenants

storagePorts

storageSystems

virtualNasServers

storageTiers

unmanagedFileSystems

unmanagedVolumes

unmanagedCGs

unmanagedExports

authnProviders

autoTierPolicies

tenants

workflows

vdc

audit

monitoring

metering

computeSystems

computeElements

keystore

truststore

tasks

customConfigs

getUserGroup

site

ipsec

schedulePolicies

application