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.events.cloud.gkehub.v1.Authority
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Authority.BuilderImplements
AuthorityOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Authority.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
Authority.Builder |
build()
public Authority build()
Returns | |
---|---|
Type | Description |
Authority |
buildPartial()
public Authority buildPartial()
Returns | |
---|---|
Type | Description |
Authority |
clear()
public Authority.Builder clear()
Returns | |
---|---|
Type | Description |
Authority.Builder |
clearField(Descriptors.FieldDescriptor field)
public Authority.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
Authority.Builder |
clearIdentityProvider()
public Authority.Builder clearIdentityProvider()
Output only. An identity provider that reflects the issuer
in the
workload identity pool.
string identity_provider = 3;
Returns | |
---|---|
Type | Description |
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;
Returns | |
---|---|
Type | Description |
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;
Returns | |
---|---|
Type | Description |
Authority.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Authority.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
Authority.Builder |
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;
Returns | |
---|---|
Type | Description |
Authority.Builder | This builder for chaining. |
clone()
public Authority.Builder clone()
Returns | |
---|---|
Type | Description |
Authority.Builder |
getDefaultInstanceForType()
public Authority getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Authority |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getIdentityProvider()
public String getIdentityProvider()
Output only. An identity provider that reflects the issuer
in the
workload identity pool.
string identity_provider = 3;
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;
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;
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;
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;
Returns | |
---|---|
Type | Description |
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;
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;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for workloadIdentityPool. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(Authority other)
public Authority.Builder mergeFrom(Authority other)
Parameter | |
---|---|
Name | Description |
other | Authority |
Returns | |
---|---|
Type | Description |
Authority.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Authority.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Authority.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public Authority.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
Authority.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Authority.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Authority.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public Authority.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
Authority.Builder |
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;
Parameter | |
---|---|
Name | Description |
value | String The identityProvider to set. |
Returns | |
---|---|
Type | Description |
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;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for identityProvider to set. |
Returns | |
---|---|
Type | Description |
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;
Parameter | |
---|---|
Name | Description |
value | String The issuer to set. |
Returns | |
---|---|
Type | Description |
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;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for issuer to set. |
Returns | |
---|---|
Type | Description |
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;
Parameter | |
---|---|
Name | Description |
value | ByteString The oidcJwks to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
Authority.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final Authority.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Authority.Builder |
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;
Parameter | |
---|---|
Name | Description |
value | String The workloadIdentityPool to set. |
Returns | |
---|---|
Type | Description |
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;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for workloadIdentityPool to set. |
Returns | |
---|---|
Type | Description |
Authority.Builder | This builder for chaining. |