Access Approval v1 API - Class AccessApprovalSettingsName (2.3.0)

public sealed class AccessApprovalSettingsName : IResourceName, IEquatable<AccessApprovalSettingsName>

Reference documentation and code samples for the Access Approval v1 API class AccessApprovalSettingsName.

Resource name for the AccessApprovalSettings resource.

Inheritance

object > AccessApprovalSettingsName

Implements

IResourceName, IEquatable AccessApprovalSettingsName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AccessApproval.V1

Assembly

Google.Cloud.AccessApproval.V1.dll

Constructors

AccessApprovalSettingsName(string)

public AccessApprovalSettingsName(string projectId)

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

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

Properties

FolderId

public string FolderId { get; }

The Folder ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type	Description
`bool`

OrganizationId

public string OrganizationId { get; }

The Organization ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

Type

public AccessApprovalSettingsName.ResourceNameType Type { get; }

The AccessApprovalSettingsName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AccessApprovalSettingsNameResourceNameType`

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 AccessApprovalSettingsName with pattern projects/{project}/accessApprovalSettings.

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

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

FormatFolder(string)

public static string FormatFolder(string folderId)

Formats the IDs into the string representation of this AccessApprovalSettingsName with pattern folders/{folder}/accessApprovalSettings.

Parameter
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AccessApprovalSettingsName with pattern `folders/{folder}/accessApprovalSettings`.

FormatOrganization(string)

public static string FormatOrganization(string organizationId)

Formats the IDs into the string representation of this AccessApprovalSettingsName with pattern organizations/{organization}/accessApprovalSettings.

Parameter
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AccessApprovalSettingsName with pattern `organizations/{organization}/accessApprovalSettings`.

FormatProject(string)

public static string FormatProject(string projectId)

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

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

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

FromFolder(string)

public static AccessApprovalSettingsName FromFolder(string folderId)

Creates a AccessApprovalSettingsName with the pattern folders/{folder}/accessApprovalSettings.

Parameter
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.

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

FromOrganization(string)

public static AccessApprovalSettingsName FromOrganization(string organizationId)

Creates a AccessApprovalSettingsName with the pattern organizations/{organization}/accessApprovalSettings.

Parameter
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.

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

FromProject(string)

public static AccessApprovalSettingsName FromProject(string projectId)

Creates a AccessApprovalSettingsName with the pattern projects/{project}/accessApprovalSettings.

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

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

FromUnparsed(UnparsedResourceName)

public static AccessApprovalSettingsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AccessApprovalSettingsName containing an unparsed resource name.

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

Returns
Type	Description
`AccessApprovalSettingsName`	A new instance of AccessApprovalSettingsName 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 AccessApprovalSettingsName Parse(string accessApprovalSettingsName)

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

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

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

Remarks

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

projects/{project}/accessApprovalSettings
folders/{folder}/accessApprovalSettings
organizations/{organization}/accessApprovalSettings

Parse(string, bool)

public static AccessApprovalSettingsName Parse(string accessApprovalSettingsName, bool allowUnparsed)

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

Parameters
Name	Description
`accessApprovalSettingsName`	`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
`AccessApprovalSettingsName`	The parsed AccessApprovalSettingsName if successful.

Remarks

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

projects/{project}/accessApprovalSettings
folders/{folder}/accessApprovalSettings
organizations/{organization}/accessApprovalSettings

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 AccessApprovalSettingsName)

public static bool TryParse(string accessApprovalSettingsName, out AccessApprovalSettingsName result)

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

Parameters
Name	Description
`accessApprovalSettingsName`	`string` The resource name in string form. Must not be `null`.
`result`	`AccessApprovalSettingsName` When this method returns, the parsed AccessApprovalSettingsName, 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}/accessApprovalSettings
folders/{folder}/accessApprovalSettings
organizations/{organization}/accessApprovalSettings

TryParse(string, bool, out AccessApprovalSettingsName)

public static bool TryParse(string accessApprovalSettingsName, bool allowUnparsed, out AccessApprovalSettingsName result)

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

Parameters
Name	Description
`accessApprovalSettingsName`	`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`	`AccessApprovalSettingsName` When this method returns, the parsed AccessApprovalSettingsName, 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}/accessApprovalSettings
folders/{folder}/accessApprovalSettings
organizations/{organization}/accessApprovalSettings

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AccessApprovalSettingsName, AccessApprovalSettingsName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`AccessApprovalSettingsName` The first resource name to compare, or null.
`b`	`AccessApprovalSettingsName` 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 !=(AccessApprovalSettingsName, AccessApprovalSettingsName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`AccessApprovalSettingsName` The first resource name to compare, or null.
`b`	`AccessApprovalSettingsName` 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.