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

Class StsServiceCredentials

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.grpc_service.call_credentials.sts_service.v3.StsServiceCredentials
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StsServiceCredentialsOrBuilder, Serializable
public final class StsServiceCredentials extends com.google.protobuf.GeneratedMessageV3 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    StsServiceCredentials.Builder
    Security token service configuration that allows Google gRPC to fetch security token from an OAuth 2.0 authorization server.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ACTOR_TOKEN_PATH_FIELD_NUMBER
     
    static final int
    ACTOR_TOKEN_TYPE_FIELD_NUMBER
     
    static final int
    AUDIENCE_FIELD_NUMBER
     
    static final int
    REQUESTED_TOKEN_TYPE_FIELD_NUMBER
     
    static final int
    RESOURCE_FIELD_NUMBER
     
    static final int
    SCOPE_FIELD_NUMBER
     
    static final int
    SUBJECT_TOKEN_PATH_FIELD_NUMBER
     
    static final int
    SUBJECT_TOKEN_TYPE_FIELD_NUMBER
     
    static final int
    TOKEN_EXCHANGE_SERVICE_URI_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getActorTokenPath()
    The path of actor token, a security token that represents the identity of the acting party.
    com.google.protobuf.ByteString
    getActorTokenPathBytes()
    The path of actor token, a security token that represents the identity of the acting party.
    String
    getActorTokenType()
    Type of the actor token.
    com.google.protobuf.ByteString
    getActorTokenTypeBytes()
    Type of the actor token.
    String
    getAudience()
    Logical name of the target service where the client intends to use the requested security token.
    com.google.protobuf.ByteString
    getAudienceBytes()
    Logical name of the target service where the client intends to use the requested security token.
    static StsServiceCredentials
    getDefaultInstance()
     
    StsServiceCredentials
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<StsServiceCredentials>
    getParserForType()
     
    String
    getRequestedTokenType()
    Type of the requested security token.
    com.google.protobuf.ByteString
    getRequestedTokenTypeBytes()
    Type of the requested security token.
    String
    getResource()
    Location of the target service or resource where the client intends to use the requested security token.
    com.google.protobuf.ByteString
    getResourceBytes()
    Location of the target service or resource where the client intends to use the requested security token.
    String
    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
    getScopeBytes()
    The desired scope of the requested security token in the context of the service or resource where the token will be used.
    int
    getSerializedSize()
     
    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.
    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
    getSubjectTokenType()
    Type of the subject token.
    com.google.protobuf.ByteString
    getSubjectTokenTypeBytes()
    Type of the subject token.
    String
    getTokenExchangeServiceUri()
    URI of the token exchange service that handles token exchange requests.
    com.google.protobuf.ByteString
    getTokenExchangeServiceUriBytes()
    URI of the token exchange service that handles token exchange requests.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static StsServiceCredentials.Builder
    newBuilder()
     
    static StsServiceCredentials.Builder
    newBuilder(StsServiceCredentials prototype)
     
    StsServiceCredentials.Builder
    newBuilderForType()
     
    protected StsServiceCredentials.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static StsServiceCredentials
    parseDelimitedFrom(InputStream input)
     
    static StsServiceCredentials
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StsServiceCredentials
    parseFrom(byte[] data)
     
    static StsServiceCredentials
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StsServiceCredentials
    parseFrom(com.google.protobuf.ByteString data)
     
    static StsServiceCredentials
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StsServiceCredentials
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static StsServiceCredentials
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StsServiceCredentials
    parseFrom(InputStream input)
     
    static StsServiceCredentials
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StsServiceCredentials
    parseFrom(ByteBuffer data)
     
    static StsServiceCredentials
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<StsServiceCredentials>
    parser()
     
    StsServiceCredentials.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • TOKEN_EXCHANGE_SERVICE_URI_FIELD_NUMBER

      public static final int TOKEN_EXCHANGE_SERVICE_URI_FIELD_NUMBER
      See Also:

    • RESOURCE_FIELD_NUMBER

      public static final int RESOURCE_FIELD_NUMBER
      See Also:

    • AUDIENCE_FIELD_NUMBER

      public static final int AUDIENCE_FIELD_NUMBER
      See Also:

    • SCOPE_FIELD_NUMBER

      public static final int SCOPE_FIELD_NUMBER
      See Also:

    • REQUESTED_TOKEN_TYPE_FIELD_NUMBER

      public static final int REQUESTED_TOKEN_TYPE_FIELD_NUMBER
      See Also:

    • SUBJECT_TOKEN_PATH_FIELD_NUMBER

      public static final int SUBJECT_TOKEN_PATH_FIELD_NUMBER
      See Also:

    • SUBJECT_TOKEN_TYPE_FIELD_NUMBER

      public static final int SUBJECT_TOKEN_TYPE_FIELD_NUMBER
      See Also:

    • ACTOR_TOKEN_PATH_FIELD_NUMBER

      public static final int ACTOR_TOKEN_PATH_FIELD_NUMBER
      See Also:

    • ACTOR_TOKEN_TYPE_FIELD_NUMBER

      public static final int ACTOR_TOKEN_TYPE_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static StsServiceCredentials parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StsServiceCredentials parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StsServiceCredentials parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StsServiceCredentials parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StsServiceCredentials parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StsServiceCredentials parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StsServiceCredentials parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StsServiceCredentials parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StsServiceCredentials parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StsServiceCredentials parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StsServiceCredentials parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StsServiceCredentials parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static StsServiceCredentials.Builder newBuilder()

    • newBuilder

      public static StsServiceCredentials.Builder newBuilder(StsServiceCredentials prototype)

    • toBuilder

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

    • newBuilderForType

      protected StsServiceCredentials.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static StsServiceCredentials getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<StsServiceCredentials> parser()

    • getParserForType

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

    • getDefaultInstanceForType

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