Struct StartOAuthResponse 

#[non_exhaustive]
pub struct StartOAuthResponse {
    pub ticket: String,
    pub code_challenge: String,
    pub code_challenge_method: String,
    pub client_id: String,
    pub scopes: Vec<String>,
    pub auth_uri: String,
    pub id: Option<Id>,
    /* private fields */
}

Message for responding to starting an OAuth flow.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

ticket: String

The ticket to be used for post processing the callback from the service provider.

code_challenge: String

Please refer to https://datatracker.ietf.org/doc/html/rfc7636#section-4.1

code_challenge_method: String

Please refer to https://datatracker.ietf.org/doc/html/rfc7636#section-4.2

client_id: String

The client ID to the OAuth App of the service provider.

scopes: Vec<String>

The list of scopes requested by the application.

auth_uri: String

The authorization server URL to the OAuth flow of the service provider.

id: Option<Id>

The ID of the service provider.

Implementations

impl StartOAuthResponse

pub fn new() -> Self

pub fn set_ticket<T: Into<String>>(self, v: T) -> Self

Sets the value of ticket.

Example

let x = StartOAuthResponse::new().set_ticket("example");

pub fn set_code_challenge<T: Into<String>>(self, v: T) -> Self

Sets the value of code_challenge.

Example

let x = StartOAuthResponse::new().set_code_challenge("example");

pub fn set_code_challenge_method<T: Into<String>>(self, v: T) -> Self

Sets the value of code_challenge_method.

Example

let x = StartOAuthResponse::new().set_code_challenge_method("example");

pub fn set_client_id<T: Into<String>>(self, v: T) -> Self

Sets the value of client_id.

Example

let x = StartOAuthResponse::new().set_client_id("example");

pub fn set_scopes<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of scopes.

Example

let x = StartOAuthResponse::new().set_scopes(["a", "b", "c"]);

pub fn set_auth_uri<T: Into<String>>(self, v: T) -> Self

Sets the value of auth_uri.

Example

let x = StartOAuthResponse::new().set_auth_uri("example");

pub fn set_id<T: Into<Option<Id>>>(self, v: T) -> Self

Sets the value of id.

Note that all the setters affecting id are mutually exclusive.

Example

use google_cloud_developerconnect_v1::model::SystemProvider;
let x0 = StartOAuthResponse::new().set_id(Some(
    google_cloud_developerconnect_v1::model::start_o_auth_response::Id::SystemProviderId(SystemProvider::Github)));
let x1 = StartOAuthResponse::new().set_id(Some(
    google_cloud_developerconnect_v1::model::start_o_auth_response::Id::SystemProviderId(SystemProvider::Gitlab)));
let x2 = StartOAuthResponse::new().set_id(Some(
    google_cloud_developerconnect_v1::model::start_o_auth_response::Id::SystemProviderId(SystemProvider::Google)));

pub fn system_provider_id(&self) -> Option<&SystemProvider>

The value of id if it holds a SystemProviderId, None if the field is not set or holds a different branch.

pub fn set_system_provider_id<T: Into<SystemProvider>>(self, v: T) -> Self

Sets the value of id to hold a SystemProviderId.

Note that all the setters affecting id are mutually exclusive.

Example

use google_cloud_developerconnect_v1::model::SystemProvider;
let x0 = StartOAuthResponse::new().set_system_provider_id(SystemProvider::Github);
let x1 = StartOAuthResponse::new().set_system_provider_id(SystemProvider::Gitlab);
let x2 = StartOAuthResponse::new().set_system_provider_id(SystemProvider::Google);
assert!(x0.system_provider_id().is_some());
assert!(x1.system_provider_id().is_some());
assert!(x2.system_provider_id().is_some());

Trait Implementations

impl Clone for StartOAuthResponse

fn clone(&self) -> StartOAuthResponse

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartOAuthResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StartOAuthResponse

fn default() -> StartOAuthResponse

Returns the “default value” for a type.

impl Message for StartOAuthResponse

fn typename() -> &'static str

The typename of this message.

impl PartialEq for StartOAuthResponse

fn eq(&self, other: &StartOAuthResponse) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartOAuthResponse