Class GrpcService.GoogleGrpc.CallCredentials.StsService.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<GrpcService.GoogleGrpc.CallCredentials.StsService.Builder>
com.google.protobuf.GeneratedMessage.Builder<GrpcService.GoogleGrpc.CallCredentials.StsService.Builder>
io.envoyproxy.envoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials.StsService.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,GrpcService.GoogleGrpc.CallCredentials.StsServiceOrBuilder
,Cloneable
- Enclosing class:
GrpcService.GoogleGrpc.CallCredentials.StsService
public static final class GrpcService.GoogleGrpc.CallCredentials.StsService.Builder
extends com.google.protobuf.GeneratedMessage.Builder<GrpcService.GoogleGrpc.CallCredentials.StsService.Builder>
implements GrpcService.GoogleGrpc.CallCredentials.StsServiceOrBuilder
Security token service configuration that allows Google gRPC to fetch security token from an OAuth 2.0 authorization server. See https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-16 and https://github.com/grpc/grpc/pull/19587. [#next-free-field: 10]Protobuf type
envoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials.StsService
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
private void
clear()
The path of actor token, a security token that represents the identity of the acting party.Type of the actor token.Logical name of the target service where the client intends to use the requested security token.Type of the requested security token.Location of the target service or resource where the client intends to use the requested security token.The desired scope of the requested security token in the context of the service or resource where the token will be used.The path of subject token, a security token that represents the identity of the party on behalf of whom the request is being made.Type of the subject token.URI of the token exchange service that handles token exchange requests.The path of actor token, a security token that represents the identity of the acting party.com.google.protobuf.ByteString
The path of actor token, a security token that represents the identity of the acting party.Type of the actor token.com.google.protobuf.ByteString
Type of the actor token.Logical name of the target service where the client intends to use the requested security token.com.google.protobuf.ByteString
Logical name of the target service where the client intends to use the requested security token.static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
Type of the requested security token.com.google.protobuf.ByteString
Type of the requested security token.Location of the target service or resource where the client intends to use the requested security token.com.google.protobuf.ByteString
Location of the target service or resource where the client intends to use the requested security token.getScope()
The desired scope of the requested security token in the context of the service or resource where the token will be used.com.google.protobuf.ByteString
The desired scope of the requested security token in the context of the service or resource where the token will be used.The path of subject token, a security token that represents the identity of the party on behalf of whom the request is being made.com.google.protobuf.ByteString
The path of subject token, a security token that represents the identity of the party on behalf of whom the request is being made.Type of the subject token.com.google.protobuf.ByteString
Type of the subject token.URI of the token exchange service that handles token exchange requests.com.google.protobuf.ByteString
URI of the token exchange service that handles token exchange requests.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) setActorTokenPath
(String value) The path of actor token, a security token that represents the identity of the acting party.setActorTokenPathBytes
(com.google.protobuf.ByteString value) The path of actor token, a security token that represents the identity of the acting party.setActorTokenType
(String value) Type of the actor token.setActorTokenTypeBytes
(com.google.protobuf.ByteString value) Type of the actor token.setAudience
(String value) Logical name of the target service where the client intends to use the requested security token.setAudienceBytes
(com.google.protobuf.ByteString value) Logical name of the target service where the client intends to use the requested security token.setRequestedTokenType
(String value) Type of the requested security token.setRequestedTokenTypeBytes
(com.google.protobuf.ByteString value) Type of the requested security token.setResource
(String value) Location of the target service or resource where the client intends to use the requested security token.setResourceBytes
(com.google.protobuf.ByteString value) Location of the target service or resource where the client intends to use the requested security token.The desired scope of the requested security token in the context of the service or resource where the token will be used.setScopeBytes
(com.google.protobuf.ByteString value) The desired scope of the requested security token in the context of the service or resource where the token will be used.setSubjectTokenPath
(String value) The path of subject token, a security token that represents the identity of the party on behalf of whom the request is being made.setSubjectTokenPathBytes
(com.google.protobuf.ByteString value) The path of subject token, a security token that represents the identity of the party on behalf of whom the request is being made.setSubjectTokenType
(String value) Type of the subject token.setSubjectTokenTypeBytes
(com.google.protobuf.ByteString value) Type of the subject token.setTokenExchangeServiceUri
(String value) URI of the token exchange service that handles token exchange requests.setTokenExchangeServiceUriBytes
(com.google.protobuf.ByteString value) URI of the token exchange service that handles token exchange requests.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
bitField0_
private int bitField0_ -
tokenExchangeServiceUri_
-
resource_
-
audience_
-
scope_
-
requestedTokenType_
-
subjectTokenPath_
-
subjectTokenType_
-
actorTokenPath_
-
actorTokenType_
-
-
Constructor Details
-
Builder
private Builder() -
Builder
private Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage.Builder<GrpcService.GoogleGrpc.CallCredentials.StsService.Builder>
-
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessage.Builder<GrpcService.GoogleGrpc.CallCredentials.StsService.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessage.Builder<GrpcService.GoogleGrpc.CallCredentials.StsService.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial0
-
mergeFrom
public GrpcService.GoogleGrpc.CallCredentials.StsService.Builder mergeFrom(com.google.protobuf.Message other) - Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<GrpcService.GoogleGrpc.CallCredentials.StsService.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.Builder<GrpcService.GoogleGrpc.CallCredentials.StsService.Builder>
-
mergeFrom
public GrpcService.GoogleGrpc.CallCredentials.StsService.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<GrpcService.GoogleGrpc.CallCredentials.StsService.Builder>
- Throws:
IOException
-
getTokenExchangeServiceUri
URI of the token exchange service that handles token exchange requests. [#comment:TODO(asraa): Add URI validation when implemented. Tracked by https://github.com/bufbuild/protoc-gen-validate/issues/303]
string token_exchange_service_uri = 1;
- Specified by:
getTokenExchangeServiceUri
in interfaceGrpcService.GoogleGrpc.CallCredentials.StsServiceOrBuilder
- Returns:
- The tokenExchangeServiceUri.
-
getTokenExchangeServiceUriBytes
public com.google.protobuf.ByteString getTokenExchangeServiceUriBytes()URI of the token exchange service that handles token exchange requests. [#comment:TODO(asraa): Add URI validation when implemented. Tracked by https://github.com/bufbuild/protoc-gen-validate/issues/303]
string token_exchange_service_uri = 1;
- Specified by:
getTokenExchangeServiceUriBytes
in interfaceGrpcService.GoogleGrpc.CallCredentials.StsServiceOrBuilder
- Returns:
- The bytes for tokenExchangeServiceUri.
-
setTokenExchangeServiceUri
public GrpcService.GoogleGrpc.CallCredentials.StsService.Builder setTokenExchangeServiceUri(String value) URI of the token exchange service that handles token exchange requests. [#comment:TODO(asraa): Add URI validation when implemented. Tracked by https://github.com/bufbuild/protoc-gen-validate/issues/303]
string token_exchange_service_uri = 1;
- Parameters:
value
- The tokenExchangeServiceUri to set.- Returns:
- This builder for chaining.
-
clearTokenExchangeServiceUri
URI of the token exchange service that handles token exchange requests. [#comment:TODO(asraa): Add URI validation when implemented. Tracked by https://github.com/bufbuild/protoc-gen-validate/issues/303]
string token_exchange_service_uri = 1;
- Returns:
- This builder for chaining.
-
setTokenExchangeServiceUriBytes
public GrpcService.GoogleGrpc.CallCredentials.StsService.Builder setTokenExchangeServiceUriBytes(com.google.protobuf.ByteString value) URI of the token exchange service that handles token exchange requests. [#comment:TODO(asraa): Add URI validation when implemented. Tracked by https://github.com/bufbuild/protoc-gen-validate/issues/303]
string token_exchange_service_uri = 1;
- Parameters:
value
- The bytes for tokenExchangeServiceUri to set.- Returns:
- This builder for chaining.
-
getResource
Location of the target service or resource where the client intends to use the requested security token.
string resource = 2;
- Specified by:
getResource
in interfaceGrpcService.GoogleGrpc.CallCredentials.StsServiceOrBuilder
- Returns:
- The resource.
-
getResourceBytes
public com.google.protobuf.ByteString getResourceBytes()Location of the target service or resource where the client intends to use the requested security token.
string resource = 2;
- Specified by:
getResourceBytes
in interfaceGrpcService.GoogleGrpc.CallCredentials.StsServiceOrBuilder
- Returns:
- The bytes for resource.
-
setResource
Location of the target service or resource where the client intends to use the requested security token.
string resource = 2;
- Parameters:
value
- The resource to set.- Returns:
- This builder for chaining.
-
clearResource
Location of the target service or resource where the client intends to use the requested security token.
string resource = 2;
- Returns:
- This builder for chaining.
-
setResourceBytes
public GrpcService.GoogleGrpc.CallCredentials.StsService.Builder setResourceBytes(com.google.protobuf.ByteString value) Location of the target service or resource where the client intends to use the requested security token.
string resource = 2;
- Parameters:
value
- The bytes for resource to set.- Returns:
- This builder for chaining.
-
getAudience
Logical name of the target service where the client intends to use the requested security token.
string audience = 3;
- Specified by:
getAudience
in interfaceGrpcService.GoogleGrpc.CallCredentials.StsServiceOrBuilder
- Returns:
- The audience.
-
getAudienceBytes
public com.google.protobuf.ByteString getAudienceBytes()Logical name of the target service where the client intends to use the requested security token.
string audience = 3;
- Specified by:
getAudienceBytes
in interfaceGrpcService.GoogleGrpc.CallCredentials.StsServiceOrBuilder
- Returns:
- The bytes for audience.
-
setAudience
Logical name of the target service where the client intends to use the requested security token.
string audience = 3;
- Parameters:
value
- The audience to set.- Returns:
- This builder for chaining.
-
clearAudience
Logical name of the target service where the client intends to use the requested security token.
string audience = 3;
- Returns:
- This builder for chaining.
-
setAudienceBytes
public GrpcService.GoogleGrpc.CallCredentials.StsService.Builder setAudienceBytes(com.google.protobuf.ByteString value) Logical name of the target service where the client intends to use the requested security token.
string audience = 3;
- Parameters:
value
- The bytes for audience to set.- Returns:
- This builder for chaining.
-
getScope
The desired scope of the requested security token in the context of the service or resource where the token will be used.
string scope = 4;
- Specified by:
getScope
in interfaceGrpcService.GoogleGrpc.CallCredentials.StsServiceOrBuilder
- Returns:
- The scope.
-
getScopeBytes
public com.google.protobuf.ByteString getScopeBytes()The desired scope of the requested security token in the context of the service or resource where the token will be used.
string scope = 4;
- Specified by:
getScopeBytes
in interfaceGrpcService.GoogleGrpc.CallCredentials.StsServiceOrBuilder
- Returns:
- The bytes for scope.
-
setScope
The desired scope of the requested security token in the context of the service or resource where the token will be used.
string scope = 4;
- Parameters:
value
- The scope to set.- Returns:
- This builder for chaining.
-
clearScope
The desired scope of the requested security token in the context of the service or resource where the token will be used.
string scope = 4;
- Returns:
- This builder for chaining.
-
setScopeBytes
public GrpcService.GoogleGrpc.CallCredentials.StsService.Builder setScopeBytes(com.google.protobuf.ByteString value) The desired scope of the requested security token in the context of the service or resource where the token will be used.
string scope = 4;
- Parameters:
value
- The bytes for scope to set.- Returns:
- This builder for chaining.
-
getRequestedTokenType
Type of the requested security token.
string requested_token_type = 5;
- Specified by:
getRequestedTokenType
in interfaceGrpcService.GoogleGrpc.CallCredentials.StsServiceOrBuilder
- Returns:
- The requestedTokenType.
-
getRequestedTokenTypeBytes
public com.google.protobuf.ByteString getRequestedTokenTypeBytes()Type of the requested security token.
string requested_token_type = 5;
- Specified by:
getRequestedTokenTypeBytes
in interfaceGrpcService.GoogleGrpc.CallCredentials.StsServiceOrBuilder
- Returns:
- The bytes for requestedTokenType.
-
setRequestedTokenType
public GrpcService.GoogleGrpc.CallCredentials.StsService.Builder setRequestedTokenType(String value) Type of the requested security token.
string requested_token_type = 5;
- Parameters:
value
- The requestedTokenType to set.- Returns:
- This builder for chaining.
-
clearRequestedTokenType
Type of the requested security token.
string requested_token_type = 5;
- Returns:
- This builder for chaining.
-
setRequestedTokenTypeBytes
public GrpcService.GoogleGrpc.CallCredentials.StsService.Builder setRequestedTokenTypeBytes(com.google.protobuf.ByteString value) Type of the requested security token.
string requested_token_type = 5;
- Parameters:
value
- The bytes for requestedTokenType to set.- Returns:
- This builder for chaining.
-
getSubjectTokenPath
The path of subject token, a security token that represents the identity of the party on behalf of whom the request is being made.
string subject_token_path = 6 [(.validate.rules) = { ... }
- Specified by:
getSubjectTokenPath
in interfaceGrpcService.GoogleGrpc.CallCredentials.StsServiceOrBuilder
- Returns:
- The subjectTokenPath.
-
getSubjectTokenPathBytes
public com.google.protobuf.ByteString getSubjectTokenPathBytes()The path of subject token, a security token that represents the identity of the party on behalf of whom the request is being made.
string subject_token_path = 6 [(.validate.rules) = { ... }
- Specified by:
getSubjectTokenPathBytes
in interfaceGrpcService.GoogleGrpc.CallCredentials.StsServiceOrBuilder
- Returns:
- The bytes for subjectTokenPath.
-
setSubjectTokenPath
The path of subject token, a security token that represents the identity of the party on behalf of whom the request is being made.
string subject_token_path = 6 [(.validate.rules) = { ... }
- Parameters:
value
- The subjectTokenPath to set.- Returns:
- This builder for chaining.
-
clearSubjectTokenPath
The path of subject token, a security token that represents the identity of the party on behalf of whom the request is being made.
string subject_token_path = 6 [(.validate.rules) = { ... }
- Returns:
- This builder for chaining.
-
setSubjectTokenPathBytes
public GrpcService.GoogleGrpc.CallCredentials.StsService.Builder setSubjectTokenPathBytes(com.google.protobuf.ByteString value) The path of subject token, a security token that represents the identity of the party on behalf of whom the request is being made.
string subject_token_path = 6 [(.validate.rules) = { ... }
- Parameters:
value
- The bytes for subjectTokenPath to set.- Returns:
- This builder for chaining.
-
getSubjectTokenType
Type of the subject token.
string subject_token_type = 7 [(.validate.rules) = { ... }
- Specified by:
getSubjectTokenType
in interfaceGrpcService.GoogleGrpc.CallCredentials.StsServiceOrBuilder
- Returns:
- The subjectTokenType.
-
getSubjectTokenTypeBytes
public com.google.protobuf.ByteString getSubjectTokenTypeBytes()Type of the subject token.
string subject_token_type = 7 [(.validate.rules) = { ... }
- Specified by:
getSubjectTokenTypeBytes
in interfaceGrpcService.GoogleGrpc.CallCredentials.StsServiceOrBuilder
- Returns:
- The bytes for subjectTokenType.
-
setSubjectTokenType
Type of the subject token.
string subject_token_type = 7 [(.validate.rules) = { ... }
- Parameters:
value
- The subjectTokenType to set.- Returns:
- This builder for chaining.
-
clearSubjectTokenType
Type of the subject token.
string subject_token_type = 7 [(.validate.rules) = { ... }
- Returns:
- This builder for chaining.
-
setSubjectTokenTypeBytes
public GrpcService.GoogleGrpc.CallCredentials.StsService.Builder setSubjectTokenTypeBytes(com.google.protobuf.ByteString value) Type of the subject token.
string subject_token_type = 7 [(.validate.rules) = { ... }
- Parameters:
value
- The bytes for subjectTokenType to set.- Returns:
- This builder for chaining.
-
getActorTokenPath
The path of actor token, a security token that represents the identity of the acting party. The acting party is authorized to use the requested security token and act on behalf of the subject.
string actor_token_path = 8;
- Specified by:
getActorTokenPath
in interfaceGrpcService.GoogleGrpc.CallCredentials.StsServiceOrBuilder
- Returns:
- The actorTokenPath.
-
getActorTokenPathBytes
public com.google.protobuf.ByteString getActorTokenPathBytes()The path of actor token, a security token that represents the identity of the acting party. The acting party is authorized to use the requested security token and act on behalf of the subject.
string actor_token_path = 8;
- Specified by:
getActorTokenPathBytes
in interfaceGrpcService.GoogleGrpc.CallCredentials.StsServiceOrBuilder
- Returns:
- The bytes for actorTokenPath.
-
setActorTokenPath
The path of actor token, a security token that represents the identity of the acting party. The acting party is authorized to use the requested security token and act on behalf of the subject.
string actor_token_path = 8;
- Parameters:
value
- The actorTokenPath to set.- Returns:
- This builder for chaining.
-
clearActorTokenPath
The path of actor token, a security token that represents the identity of the acting party. The acting party is authorized to use the requested security token and act on behalf of the subject.
string actor_token_path = 8;
- Returns:
- This builder for chaining.
-
setActorTokenPathBytes
public GrpcService.GoogleGrpc.CallCredentials.StsService.Builder setActorTokenPathBytes(com.google.protobuf.ByteString value) The path of actor token, a security token that represents the identity of the acting party. The acting party is authorized to use the requested security token and act on behalf of the subject.
string actor_token_path = 8;
- Parameters:
value
- The bytes for actorTokenPath to set.- Returns:
- This builder for chaining.
-
getActorTokenType
Type of the actor token.
string actor_token_type = 9;
- Specified by:
getActorTokenType
in interfaceGrpcService.GoogleGrpc.CallCredentials.StsServiceOrBuilder
- Returns:
- The actorTokenType.
-
getActorTokenTypeBytes
public com.google.protobuf.ByteString getActorTokenTypeBytes()Type of the actor token.
string actor_token_type = 9;
- Specified by:
getActorTokenTypeBytes
in interfaceGrpcService.GoogleGrpc.CallCredentials.StsServiceOrBuilder
- Returns:
- The bytes for actorTokenType.
-
setActorTokenType
Type of the actor token.
string actor_token_type = 9;
- Parameters:
value
- The actorTokenType to set.- Returns:
- This builder for chaining.
-
clearActorTokenType
Type of the actor token.
string actor_token_type = 9;
- Returns:
- This builder for chaining.
-
setActorTokenTypeBytes
public GrpcService.GoogleGrpc.CallCredentials.StsService.Builder setActorTokenTypeBytes(com.google.protobuf.ByteString value) Type of the actor token.
string actor_token_type = 9;
- Parameters:
value
- The bytes for actorTokenType to set.- Returns:
- This builder for chaining.
-