Class Authority (1.51.0)

public final class Authority extends GeneratedMessageV3 implements AuthorityOrBuilder

Authority encodes how Google will recognize identities from this Membership. See the workload identity documentation for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity

Protobuf type google.cloud.gkehub.v1.Authority

Implements

AuthorityOrBuilder

Static Fields

IDENTITY_PROVIDER_FIELD_NUMBER

public static final int IDENTITY_PROVIDER_FIELD_NUMBER
Field Value
Type Description
int

ISSUER_FIELD_NUMBER

public static final int ISSUER_FIELD_NUMBER
Field Value
Type Description
int

OIDC_JWKS_FIELD_NUMBER

public static final int OIDC_JWKS_FIELD_NUMBER
Field Value
Type Description
int

WORKLOAD_IDENTITY_POOL_FIELD_NUMBER

public static final int WORKLOAD_IDENTITY_POOL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Authority getDefaultInstance()
Returns
Type Description
Authority

getDescriptor()

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

newBuilder()

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

newBuilder(Authority prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Authority getDefaultInstanceForType()
Returns
Type Description
Authority

getIdentityProvider()

public String getIdentityProvider()

Output only. An identity provider that reflects the issuer in the workload identity pool.

string identity_provider = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The identityProvider.

getIdentityProviderBytes()

public ByteString getIdentityProviderBytes()

Output only. An identity provider that reflects the issuer in the workload identity pool.

string identity_provider = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for identityProvider.

getIssuer()

public String getIssuer()

Optional. A JSON Web Token (JWT) issuer URI. issuer must start with https:// and be a valid URL with length <2000 characters.

If set, then Google will allow valid OIDC tokens from this issuer to authenticate within the workload_identity_pool. OIDC discovery will be performed on this URI to validate tokens from the issuer.

Clearing issuer disables Workload Identity. issuer cannot be directly modified; it must be cleared (and Workload Identity disabled) before using a new issuer (and re-enabling Workload Identity).

string issuer = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The issuer.

getIssuerBytes()

public ByteString getIssuerBytes()

Optional. A JSON Web Token (JWT) issuer URI. issuer must start with https:// and be a valid URL with length <2000 characters.

If set, then Google will allow valid OIDC tokens from this issuer to authenticate within the workload_identity_pool. OIDC discovery will be performed on this URI to validate tokens from the issuer.

Clearing issuer disables Workload Identity. issuer cannot be directly modified; it must be cleared (and Workload Identity disabled) before using a new issuer (and re-enabling Workload Identity).

string issuer = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for issuer.

getOidcJwks()

public ByteString getOidcJwks()

Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517).

When this field is set, OIDC discovery will NOT be performed on issuer, and instead OIDC tokens will be validated using this field.

bytes oidc_jwks = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The oidcJwks.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getWorkloadIdentityPool()

public String getWorkloadIdentityPool()

Output only. The name of the workload identity pool in which issuer will be recognized.

There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is {PROJECT_ID}.hub.id.goog, although this is subject to change in newer versions of this API.

string workload_identity_pool = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The workloadIdentityPool.

getWorkloadIdentityPoolBytes()

public ByteString getWorkloadIdentityPoolBytes()

Output only. The name of the workload identity pool in which issuer will be recognized.

There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is {PROJECT_ID}.hub.id.goog, although this is subject to change in newer versions of this API.

string workload_identity_pool = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for workloadIdentityPool.

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 Authority.Builder newBuilderForType()
Returns
Type Description
Authority.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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