Package org.opensearch.client.opensearch.security

Class AuthinfoResponse

java.lang.Object
org.opensearch.client.opensearch.security.AuthinfoResponse
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<AuthinfoResponse.Builder,AuthinfoResponse>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class AuthinfoResponse extends Object implements PlainJsonSerializable, ToCopyableBuilder<AuthinfoResponse.Builder,AuthinfoResponse>

  • Field Details

  • Method Details

    • of

      public static AuthinfoResponse of(Function<AuthinfoResponse.Builder,ObjectBuilder<AuthinfoResponse>> fn)

    • backendRoles

      @Nonnull public final List<String> backendRoles()
      The backend roles associated with the user.

      API name: backend_roles

    • customAttributeNames

      @Nonnull public final List<String> customAttributeNames()
      The name of the attributes associated with the user.

      API name: custom_attribute_names

    • peerCertificates

      @Nullable public final String peerCertificates()
      The number of peer certificates related to the user.

      API name: peer_certificates

    • principal

      @Nullable public final String principal()
      The user's principal.

      API name: principal

    • remoteAddress

      @Nullable public final String remoteAddress()
      The IP address of remote user.

      API name: remote_address

    • roles

      @Nonnull public final List<String> roles()
      The roles associated with the user.

      API name: roles

    • sizeOfBackendroles

      @Nullable public final String sizeOfBackendroles()
      The size of the user's backend roles in bytes.

      API name: size_of_backendroles

    • sizeOfCustomAttributes

      @Nullable public final String sizeOfCustomAttributes()
      The size of the user's custom attributes in bytes.

      API name: size_of_custom_attributes

    • sizeOfUser

      @Nullable public final String sizeOfUser()
      The size of user contained in memory.

      API name: size_of_user

    • ssoLogoutUrl

      @Nullable public final String ssoLogoutUrl()
      The logout URL.

      API name: sso_logout_url

    • tenants

      @Nonnull public final Map<String,Boolean> tenants()
      The tenants the user has access to with read-write or read-only access indicators.

      API name: tenants

    • user

      @Nullable public final String user()
      A user object as a string.

      API name: user

    • userName

      @Nullable public final String userName()
      The username.

      API name: user_name

    • userRequestedTenant

      @Nullable public final String userRequestedTenant()
      The name of the tenant the user would like to switch to.

      API name: user_requested_tenant

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toBuilder

      @Nonnull public AuthinfoResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AuthinfoResponse.Builder,AuthinfoResponse>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static AuthinfoResponse.Builder builder()

    • setupAuthinfoResponseDeserializer

      protected static void setupAuthinfoResponseDeserializer(ObjectDeserializer<AuthinfoResponse.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object