Class AttachedOidcConfig (0.42.0)

public final class AttachedOidcConfig extends GeneratedMessageV3 implements AttachedOidcConfigOrBuilder

OIDC discovery information of the target cluster.

Kubernetes Service Account (KSA) tokens are JWT tokens signed by the cluster API server. This fields indicates how Google Cloud Platform services validate KSA tokens in order to allow system workloads (such as GKE Connect and telemetry agents) to authenticate back to Google Cloud Platform.

Both clusters with public and private issuer URLs are supported. Clusters with public issuers only need to specify the issuer_url field while clusters with private issuers need to provide both issuer_url and oidc_jwks.

Protobuf type google.cloud.gkemulticloud.v1.AttachedOidcConfig

Static Fields

ISSUER_URL_FIELD_NUMBER

public static final int ISSUER_URL_FIELD_NUMBER
Field Value
Type Description
int

JWKS_FIELD_NUMBER

public static final int JWKS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AttachedOidcConfig getDefaultInstance()
Returns
Type Description
AttachedOidcConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AttachedOidcConfig.Builder newBuilder()
Returns
Type Description
AttachedOidcConfig.Builder

newBuilder(AttachedOidcConfig prototype)

public static AttachedOidcConfig.Builder newBuilder(AttachedOidcConfig prototype)
Parameter
Name Description
prototype AttachedOidcConfig
Returns
Type Description
AttachedOidcConfig.Builder

parseDelimitedFrom(InputStream input)

public static AttachedOidcConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AttachedOidcConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AttachedOidcConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AttachedOidcConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AttachedOidcConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AttachedOidcConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AttachedOidcConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AttachedOidcConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AttachedOidcConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AttachedOidcConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AttachedOidcConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AttachedOidcConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AttachedOidcConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AttachedOidcConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AttachedOidcConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AttachedOidcConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AttachedOidcConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AttachedOidcConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AttachedOidcConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AttachedOidcConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AttachedOidcConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AttachedOidcConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AttachedOidcConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AttachedOidcConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AttachedOidcConfig> parser()
Returns
Type Description
Parser<AttachedOidcConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public AttachedOidcConfig getDefaultInstanceForType()
Returns
Type Description
AttachedOidcConfig

getIssuerUrl()

public String getIssuerUrl()

A JSON Web Token (JWT) issuer URI. issuer must start with https://.

string issuer_url = 1;

Returns
Type Description
String

The issuerUrl.

getIssuerUrlBytes()

public ByteString getIssuerUrlBytes()

A JSON Web Token (JWT) issuer URI. issuer must start with https://.

string issuer_url = 1;

Returns
Type Description
ByteString

The bytes for issuerUrl.

getJwks()

public ByteString getJwks()

Optional. OIDC verification keys in JWKS format (RFC 7517). It contains a list of OIDC verification keys that can be used to verify OIDC JWTs.

This field is required for cluster that doesn't have a publicly available discovery endpoint. When provided, it will be directly used to verify the OIDC JWT asserted by the IDP.

bytes jwks = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The jwks.

getParserForType()

public Parser<AttachedOidcConfig> getParserForType()
Returns
Type Description
Parser<AttachedOidcConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AttachedOidcConfig.Builder newBuilderForType()
Returns
Type Description
AttachedOidcConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AttachedOidcConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AttachedOidcConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AttachedOidcConfig.Builder toBuilder()
Returns
Type Description
AttachedOidcConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException