com.vmware.vapi.std.errors

Class Unauthenticated.Builder

java.lang.Object

com.vmware.vapi.std.errors.Unauthenticated.Builder

Enclosing class:

Unauthenticated

public static final class Unauthenticated.Builder
extends java.lang.Object

Builder class for Unauthenticated.

Constructor Summary

Constructors

Constructor and Description
Builder(java.util.List<LocalizableMessage> messages) Constructor with parameters for the required properties of Unauthenticated.

Method Summary

Modifier and Type	Method and Description
Unauthenticated	build()
Unauthenticated.Builder	setChallenge(java.lang.String challenge) Indicates the authentication challenges applicable to the target API provider.
Unauthenticated.Builder	setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(java.util.List<LocalizableMessage> messages)

Constructor with parameters for the required properties of Unauthenticated.

Method Detail

setData

public Unauthenticated.Builder setData(Structure data)

Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.

Methods may provide data that clients can use when responding to exceptions. Since the data that clients need may be specific to the context of the method reporting the exception, different methods that report the same exception may provide different data in the exception. The documentation for each each method will describe what, if any, data it provides for each exception it reports. The ArgumentLocations, FileLocations, and TransientIndication classes are intended as possible values for this property. DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some interfaces may provide their own specific classes for use as the value of this property when reporting exceptions from their methods.

Some methods will not set this property when reporting exceptions.

Parameters:

data - New value for the property.

setChallenge

public Unauthenticated.Builder setChallenge(java.lang.String challenge)

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

. This property was added in vSphere API 7.0.0. This property is optional because it was added in a newer version than its parent node.

Parameters:

challenge - New value for the property.

build

public Unauthenticated build()