Google Workspace Add-ons v1 API - Class AuthorizationName (2.4.0)

public sealed class AuthorizationName : IResourceName, IEquatable<AuthorizationName>

Reference documentation and code samples for the Google Workspace Add-ons v1 API class AuthorizationName.

Resource name for the Authorization resource.

Inheritance

object > AuthorizationName

Implements

IResourceName, IEquatable AuthorizationName

Inherited Members

object.GetType()

Namespace

Google.Cloud.GSuiteAddOns.V1

Assembly

Google.Cloud.GSuiteAddOns.V1.dll

Constructors

AuthorizationName(string)

public AuthorizationName(string projectId)

Constructs a new instance of a AuthorizationName class from the component parts of pattern projects/{project}/authorization

Parameter
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type	Description
`bool`

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

Type

public AuthorizationName.ResourceNameType Type { get; }

The AuthorizationName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AuthorizationNameResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type	Description
`UnparsedResourceName`

Methods

Format(string)

public static string Format(string projectId)

Formats the IDs into the string representation of this AuthorizationName with pattern projects/{project}/authorization.

Parameter
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AuthorizationName with pattern `projects/{project}/authorization`.

FormatProject(string)

public static string FormatProject(string projectId)

Formats the IDs into the string representation of this AuthorizationName with pattern projects/{project}/authorization.

Parameter
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AuthorizationName with pattern `projects/{project}/authorization`.

FromProject(string)

public static AuthorizationName FromProject(string projectId)

Creates a AuthorizationName with the pattern projects/{project}/authorization.

Parameter
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.

Returns
Type	Description
`AuthorizationName`	A new instance of AuthorizationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AuthorizationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AuthorizationName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`AuthorizationName`	A new instance of AuthorizationName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static AuthorizationName Parse(string authorizationName)

Parses the given resource name string into a new AuthorizationName instance.

Parameter
Name	Description
`authorizationName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`AuthorizationName`	The parsed AuthorizationName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/authorization

Parse(string, bool)

public static AuthorizationName Parse(string authorizationName, bool allowUnparsed)

Parses the given resource name string into a new AuthorizationName instance; optionally allowing an unparseable resource name.

Parameters
Name	Description
`authorizationName`	`string` The resource name in string form. Must not be `null`.
`allowUnparsed`	`bool` If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns
Type	Description
`AuthorizationName`	The parsed AuthorizationName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/authorization

Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type	Description
`string`	The string representation of the resource name.

Overrides

object.ToString()

TryParse(string, out AuthorizationName)

public static bool TryParse(string authorizationName, out AuthorizationName result)

Tries to parse the given resource name string into a new AuthorizationName instance.

Parameters
Name	Description
`authorizationName`	`string` The resource name in string form. Must not be `null`.
`result`	`AuthorizationName` When this method returns, the parsed AuthorizationName, or `null` if parsing failed.

Returns
Type	Description
`bool`	`true` if the name was parsed successfully; `false` otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/authorization

TryParse(string, bool, out AuthorizationName)

public static bool TryParse(string authorizationName, bool allowUnparsed, out AuthorizationName result)

Tries to parse the given resource name string into a new AuthorizationName instance; optionally allowing an unparseable resource name.

Parameters
Name	Description
`authorizationName`	`string` The resource name in string form. Must not be `null`.
`allowUnparsed`	`bool` If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
`result`	`AuthorizationName` When this method returns, the parsed AuthorizationName, or `null` if parsing failed.

Returns
Type	Description
`bool`	`true` if the name was parsed successfully; `false` otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/authorization

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AuthorizationName, AuthorizationName)

public static bool operator ==(AuthorizationName a, AuthorizationName b)

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`AuthorizationName` The first resource name to compare, or null.
`b`	`AuthorizationName` The second resource name to compare, or null.

Returns
Type	Description
`bool`	true if the value of `a` is the same as the value of `b`; otherwise, false.

operator !=(AuthorizationName, AuthorizationName)

public static bool operator !=(AuthorizationName a, AuthorizationName b)

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`AuthorizationName` The first resource name to compare, or null.
`b`	`AuthorizationName` The second resource name to compare, or null.

Returns
Type	Description
`bool`	true if the value of `a` is different from the value of `b`; otherwise, false.