io.envoyproxy.envoy.extensions.injected_credentials.oauth2.v3.OAuth2OrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of envoy-api Show documentation
envoy-api
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: envoy/extensions/injected_credentials/oauth2/v3/oauth2.proto

package io.envoyproxy.envoy.extensions.injected_credentials.oauth2.v3;

public interface OAuth2OrBuilder extends
    // @@protoc_insertion_point(interface_extends:envoy.extensions.injected_credentials.oauth2.v3.OAuth2)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Endpoint on the authorization server to retrieve the access token from.
   * Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-3.2) for details.
   * 
   *
   * .envoy.config.core.v3.HttpUri token_endpoint = 1 [(.validate.rules) = { ... }
   * @return Whether the tokenEndpoint field is set.
   */
  boolean hasTokenEndpoint();
  /**
   *    * Endpoint on the authorization server to retrieve the access token from.
   * Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-3.2) for details.
   * 
   *
   * .envoy.config.core.v3.HttpUri token_endpoint = 1 [(.validate.rules) = { ... }
   * @return The tokenEndpoint.
   */
  io.envoyproxy.envoy.config.core.v3.HttpUri getTokenEndpoint();
  /**
   *    * Endpoint on the authorization server to retrieve the access token from.
   * Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-3.2) for details.
   * 
   *
   * .envoy.config.core.v3.HttpUri token_endpoint = 1 [(.validate.rules) = { ... }
   */
  io.envoyproxy.envoy.config.core.v3.HttpUriOrBuilder getTokenEndpointOrBuilder();

  /**
   *    * Optional list of OAuth scopes to be claimed in the authorization request.
   * Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-4.4.2) for details.
   * 
   *
   * repeated string scopes = 2;
   * @return A list containing the scopes.
   */
  java.util.List
      getScopesList();
  /**
   *    * Optional list of OAuth scopes to be claimed in the authorization request.
   * Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-4.4.2) for details.
   * 
   *
   * repeated string scopes = 2;
   * @return The count of scopes.
   */
  int getScopesCount();
  /**
   *    * Optional list of OAuth scopes to be claimed in the authorization request.
   * Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-4.4.2) for details.
   * 
   *
   * repeated string scopes = 2;
   * @param index The index of the element to return.
   * @return The scopes at the given index.
   */
  java.lang.String getScopes(int index);
  /**
   *    * Optional list of OAuth scopes to be claimed in the authorization request.
   * Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-4.4.2) for details.
   * 
   *
   * repeated string scopes = 2;
   * @param index The index of the value to return.
   * @return The bytes of the scopes at the given index.
   */
  com.google.protobuf.ByteString
      getScopesBytes(int index);

  /**
   *    * Client Credentials Grant.
   * Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-4.4) for details.
   * 
   *
   * .envoy.extensions.injected_credentials.oauth2.v3.OAuth2.ClientCredentials client_credentials = 3;
   * @return Whether the clientCredentials field is set.
   */
  boolean hasClientCredentials();
  /**
   *    * Client Credentials Grant.
   * Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-4.4) for details.
   * 
   *
   * .envoy.extensions.injected_credentials.oauth2.v3.OAuth2.ClientCredentials client_credentials = 3;
   * @return The clientCredentials.
   */
  io.envoyproxy.envoy.extensions.injected_credentials.oauth2.v3.OAuth2.ClientCredentials getClientCredentials();
  /**
   *    * Client Credentials Grant.
   * Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-4.4) for details.
   * 
   *
   * .envoy.extensions.injected_credentials.oauth2.v3.OAuth2.ClientCredentials client_credentials = 3;
   */
  io.envoyproxy.envoy.extensions.injected_credentials.oauth2.v3.OAuth2.ClientCredentialsOrBuilder getClientCredentialsOrBuilder();

  public io.envoyproxy.envoy.extensions.injected_credentials.oauth2.v3.OAuth2.FlowTypeCase getFlowTypeCase();
}