Package io.envoyproxy.envoy.extensions.grpc_service.call_credentials.sts_service.v3

Class StsServiceCredentials.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<StsServiceCredentials.Builder>
io.envoyproxy.envoy.extensions.grpc_service.call_credentials.sts_service.v3.StsServiceCredentials.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StsServiceCredentialsOrBuilder, Cloneable
Enclosing class:
StsServiceCredentials
public static final class StsServiceCredentials.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<StsServiceCredentials.Builder> implements StsServiceCredentialsOrBuilder
 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.
 [#not-implemented-hide:]
 [#next-free-field: 10]
Protobuf type envoy.extensions.grpc_service.call_credentials.sts_service.v3.StsServiceCredentials

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<StsServiceCredentials.Builder>

    • clear

      public StsServiceCredentials.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<StsServiceCredentials.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<StsServiceCredentials.Builder>

    • getDefaultInstanceForType

      public StsServiceCredentials getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public StsServiceCredentials build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public StsServiceCredentials buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public StsServiceCredentials.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<StsServiceCredentials.Builder>

    • setField

      public StsServiceCredentials.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<StsServiceCredentials.Builder>

    • clearField

      public StsServiceCredentials.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<StsServiceCredentials.Builder>

    • clearOneof

      public StsServiceCredentials.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<StsServiceCredentials.Builder>

    • setRepeatedField

      public StsServiceCredentials.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StsServiceCredentials.Builder>

    • addRepeatedField

      public StsServiceCredentials.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StsServiceCredentials.Builder>

    • mergeFrom

      public StsServiceCredentials.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StsServiceCredentials.Builder>

    • mergeFrom

      public StsServiceCredentials.Builder mergeFrom(StsServiceCredentials other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<StsServiceCredentials.Builder>

    • mergeFrom

      public StsServiceCredentials.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StsServiceCredentials.Builder>
      Throws:
      IOException

    • getTokenExchangeServiceUri

      public String 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 interface StsServiceCredentialsOrBuilder
      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 interface StsServiceCredentialsOrBuilder
      Returns:
      The bytes for tokenExchangeServiceUri.

    • setTokenExchangeServiceUri

      public StsServiceCredentials.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

      public StsServiceCredentials.Builder 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 StsServiceCredentials.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

      public String 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 interface StsServiceCredentialsOrBuilder
      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 interface StsServiceCredentialsOrBuilder
      Returns:
      The bytes for resource.

    • setResource

      public StsServiceCredentials.Builder setResource(String value)
       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

      public StsServiceCredentials.Builder 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 StsServiceCredentials.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

      public String getAudience()
       Logical name of the target service where the client intends to
 use the requested security token.
      string audience = 3;
      Specified by:
      getAudience in interface StsServiceCredentialsOrBuilder
      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 interface StsServiceCredentialsOrBuilder
      Returns:
      The bytes for audience.

    • setAudience

      public StsServiceCredentials.Builder setAudience(String value)
       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

      public StsServiceCredentials.Builder 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 StsServiceCredentials.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

      public String 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 interface StsServiceCredentialsOrBuilder
      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 interface StsServiceCredentialsOrBuilder
      Returns:
      The bytes for scope.

    • setScope

      public StsServiceCredentials.Builder setScope(String 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 scope to set.
      Returns:
      This builder for chaining.

    • clearScope

      public StsServiceCredentials.Builder 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 StsServiceCredentials.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

      public String getRequestedTokenType()
       Type of the requested security token.
      string requested_token_type = 5;
      Specified by:
      getRequestedTokenType in interface StsServiceCredentialsOrBuilder
      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 interface StsServiceCredentialsOrBuilder
      Returns:
      The bytes for requestedTokenType.

    • setRequestedTokenType

      public StsServiceCredentials.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

      public StsServiceCredentials.Builder clearRequestedTokenType()
       Type of the requested security token.
      string requested_token_type = 5;
      Returns:
      This builder for chaining.

    • setRequestedTokenTypeBytes

      public StsServiceCredentials.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

      public String 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 interface StsServiceCredentialsOrBuilder
      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 interface StsServiceCredentialsOrBuilder
      Returns:
      The bytes for subjectTokenPath.

    • setSubjectTokenPath

      public StsServiceCredentials.Builder 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.
      string subject_token_path = 6 [(.validate.rules) = { ... }
      Parameters:
      value - The subjectTokenPath to set.
      Returns:
      This builder for chaining.

    • clearSubjectTokenPath

      public StsServiceCredentials.Builder 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 StsServiceCredentials.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

      public String getSubjectTokenType()
       Type of the subject token.
      string subject_token_type = 7 [(.validate.rules) = { ... }
      Specified by:
      getSubjectTokenType in interface StsServiceCredentialsOrBuilder
      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 interface StsServiceCredentialsOrBuilder
      Returns:
      The bytes for subjectTokenType.

    • setSubjectTokenType

      public StsServiceCredentials.Builder setSubjectTokenType(String value)
       Type of the subject token.
      string subject_token_type = 7 [(.validate.rules) = { ... }
      Parameters:
      value - The subjectTokenType to set.
      Returns:
      This builder for chaining.

    • clearSubjectTokenType

      public StsServiceCredentials.Builder clearSubjectTokenType()
       Type of the subject token.
      string subject_token_type = 7 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setSubjectTokenTypeBytes

      public StsServiceCredentials.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

      public String 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 interface StsServiceCredentialsOrBuilder
      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 interface StsServiceCredentialsOrBuilder
      Returns:
      The bytes for actorTokenPath.

    • setActorTokenPath

      public StsServiceCredentials.Builder setActorTokenPath(String 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 actorTokenPath to set.
      Returns:
      This builder for chaining.

    • clearActorTokenPath

      public StsServiceCredentials.Builder 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 StsServiceCredentials.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

      public String getActorTokenType()
       Type of the actor token.
      string actor_token_type = 9;
      Specified by:
      getActorTokenType in interface StsServiceCredentialsOrBuilder
      Returns:
      The actorTokenType.

    • getActorTokenTypeBytes

      public com.google.protobuf.ByteString getActorTokenTypeBytes()
       Type of the actor token.
      string actor_token_type = 9;
      Specified by:
      getActorTokenTypeBytes in interface StsServiceCredentialsOrBuilder
      Returns:
      The bytes for actorTokenType.

    • setActorTokenType

      public StsServiceCredentials.Builder setActorTokenType(String value)
       Type of the actor token.
      string actor_token_type = 9;
      Parameters:
      value - The actorTokenType to set.
      Returns:
      This builder for chaining.

    • clearActorTokenType

      public StsServiceCredentials.Builder clearActorTokenType()
       Type of the actor token.
      string actor_token_type = 9;
      Returns:
      This builder for chaining.

    • setActorTokenTypeBytes

      public StsServiceCredentials.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.

    • setUnknownFields

      public final StsServiceCredentials.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StsServiceCredentials.Builder>

    • mergeUnknownFields

      public final StsServiceCredentials.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StsServiceCredentials.Builder>