Class Authority.Builder (1.20.0)

public static final class Authority.Builder extends GeneratedMessageV3.Builder<Authority.Builder> 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 Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Authority.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Authority.Builder
Overrides

build()

public Authority build()
Returns
TypeDescription
Authority

buildPartial()

public Authority buildPartial()
Returns
TypeDescription
Authority

clear()

public Authority.Builder clear()
Returns
TypeDescription
Authority.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Authority.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Authority.Builder
Overrides

clearIdentityProvider()

public Authority.Builder clearIdentityProvider()

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
TypeDescription
Authority.Builder

This builder for chaining.

clearIssuer()

public Authority.Builder clearIssuer()

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
TypeDescription
Authority.Builder

This builder for chaining.

clearOidcJwks()

public Authority.Builder clearOidcJwks()

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
TypeDescription
Authority.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Authority.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Authority.Builder
Overrides

clearWorkloadIdentityPool()

public Authority.Builder clearWorkloadIdentityPool()

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
TypeDescription
Authority.Builder

This builder for chaining.

clone()

public Authority.Builder clone()
Returns
TypeDescription
Authority.Builder
Overrides

getDefaultInstanceForType()

public Authority getDefaultInstanceForType()
Returns
TypeDescription
Authority

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The oidcJwks.

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
TypeDescription
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
TypeDescription
ByteString

The bytes for workloadIdentityPool.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Authority other)

public Authority.Builder mergeFrom(Authority other)
Parameter
NameDescription
otherAuthority
Returns
TypeDescription
Authority.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Authority.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Authority.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Authority.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Authority.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Authority.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Authority.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public Authority.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Authority.Builder
Overrides

setIdentityProvider(String value)

public Authority.Builder setIdentityProvider(String value)

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

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

Parameter
NameDescription
valueString

The identityProvider to set.

Returns
TypeDescription
Authority.Builder

This builder for chaining.

setIdentityProviderBytes(ByteString value)

public Authority.Builder setIdentityProviderBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for identityProvider to set.

Returns
TypeDescription
Authority.Builder

This builder for chaining.

setIssuer(String value)

public Authority.Builder setIssuer(String value)

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];

Parameter
NameDescription
valueString

The issuer to set.

Returns
TypeDescription
Authority.Builder

This builder for chaining.

setIssuerBytes(ByteString value)

public Authority.Builder setIssuerBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for issuer to set.

Returns
TypeDescription
Authority.Builder

This builder for chaining.

setOidcJwks(ByteString value)

public Authority.Builder setOidcJwks(ByteString value)

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];

Parameter
NameDescription
valueByteString

The oidcJwks to set.

Returns
TypeDescription
Authority.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Authority.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Authority.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Authority.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Authority.Builder
Overrides

setWorkloadIdentityPool(String value)

public Authority.Builder setWorkloadIdentityPool(String value)

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];

Parameter
NameDescription
valueString

The workloadIdentityPool to set.

Returns
TypeDescription
Authority.Builder

This builder for chaining.

setWorkloadIdentityPoolBytes(ByteString value)

public Authority.Builder setWorkloadIdentityPoolBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for workloadIdentityPool to set.

Returns
TypeDescription
Authority.Builder

This builder for chaining.