Package software.amazon.awssdk.services.grafana.model

Class IdpMetadata

java.lang.Object

software.amazon.awssdk.services.grafana.model.IdpMetadata

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IdpMetadata.Builder,IdpMetadata>

@Generated("software.amazon.awssdk:codegen")
public final class IdpMetadata
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IdpMetadata.Builder,IdpMetadata>

A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace. You can specify the metadata either by providing a URL to its location in the url parameter, or by specifying the full metadata in XML format in the xml parameter. Specifying both will cause an error.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IdpMetadata.Builder
static class	IdpMetadata.Type

Method Summary

Modifier and Type	Method	Description
static IdpMetadata.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static IdpMetadata	fromUrl(String url)	Create an instance of this class with url() initialized to the given value.
static IdpMetadata	fromXml(String xml)	Create an instance of this class with xml() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends IdpMetadata.Builder>	serializableBuilderClass()
IdpMetadata.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
IdpMetadata.Type	type()	Retrieve an enum value representing which member of this object is populated.
String	url()	The URL of the location containing the IdP metadata.
String	xml()	The full IdP metadata, in XML format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

url

public final String url()

The URL of the location containing the IdP metadata.

Returns:

The URL of the location containing the IdP metadata.

xml

public final String xml()

The full IdP metadata, in XML format.

Returns:

The full IdP metadata, in XML format.

toBuilder

public IdpMetadata.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IdpMetadata.Builder,IdpMetadata>

builder

public static IdpMetadata.Builder builder()

serializableBuilderClass

public static Class<? extends IdpMetadata.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

fromUrl

public static IdpMetadata fromUrl(String url)

Create an instance of this class with url() initialized to the given value.

The URL of the location containing the IdP metadata.

Parameters:

url - The URL of the location containing the IdP metadata.

fromXml

public static IdpMetadata fromXml(String xml)

Create an instance of this class with xml() initialized to the given value.

The full IdP metadata, in XML format.

Parameters:

xml - The full IdP metadata, in XML format.

type

public IdpMetadata.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be IdpMetadata.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be IdpMetadata.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo