Privileged Access Manager v1 API - Class GrantName (1.0.0-beta01)

public sealed class GrantName : IResourceName, IEquatable<GrantName>

Reference documentation and code samples for the Privileged Access Manager v1 API class GrantName.

Resource name for the Grant resource.

Inheritance

object > GrantName

Implements

IResourceName, IEquatable GrantName

Inherited Members

object.GetType()

Namespace

Google.Cloud.PrivilegedAccessManager.V1

Assembly

Google.Cloud.PrivilegedAccessManager.V1.dll

Constructors

GrantName(string, string, string, string)

public GrantName(string projectId, string locationId, string entitlementId, string grantId)

Constructs a new instance of a GrantName class from the component parts of pattern projects/{project}/locations/{location}/entitlements/{entitlement}/grants/{grant}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`entitlementId`	`string` The `Entitlement` ID. Must not be `null` or empty.
`grantId`	`string` The `Grant` ID. Must not be `null` or empty.

Properties

EntitlementId

public string EntitlementId { get; }

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

Property Value
Type	Description
`string`

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`

GrantId

public string GrantId { get; }

The Grant 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`

LocationId

public string LocationId { get; }

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

Property Value
Type	Description
`string`

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 GrantName.ResourceNameType Type { get; }

The GrantName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`GrantNameResourceNameType`

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, string, string, string)

public static string Format(string projectId, string locationId, string entitlementId, string grantId)

Formats the IDs into the string representation of this GrantName with pattern projects/{project}/locations/{location}/entitlements/{entitlement}/grants/{grant}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`entitlementId`	`string` The `Entitlement` ID. Must not be `null` or empty.
`grantId`	`string` The `Grant` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this GrantName with pattern `projects/{project}/locations/{location}/entitlements/{entitlement}/grants/{grant}`.

FormatFolderLocationEntitlementGrant(string, string, string, string)

public static string FormatFolderLocationEntitlementGrant(string folderId, string locationId, string entitlementId, string grantId)

Formats the IDs into the string representation of this GrantName with pattern folders/{folder}/locations/{location}/entitlements/{entitlement}/grants/{grant}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`entitlementId`	`string` The `Entitlement` ID. Must not be `null` or empty.
`grantId`	`string` The `Grant` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this GrantName with pattern `folders/{folder}/locations/{location}/entitlements/{entitlement}/grants/{grant}`.

FormatOrganizationLocationEntitlementGrant(string, string, string, string)

public static string FormatOrganizationLocationEntitlementGrant(string organizationId, string locationId, string entitlementId, string grantId)

Formats the IDs into the string representation of this GrantName with pattern organizations/{organization}/locations/{location}/entitlements/{entitlement}/grants/{grant}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`entitlementId`	`string` The `Entitlement` ID. Must not be `null` or empty.
`grantId`	`string` The `Grant` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this GrantName with pattern `organizations/{organization}/locations/{location}/entitlements/{entitlement}/grants/{grant}`.

FormatProjectLocationEntitlementGrant(string, string, string, string)

public static string FormatProjectLocationEntitlementGrant(string projectId, string locationId, string entitlementId, string grantId)

Formats the IDs into the string representation of this GrantName with pattern projects/{project}/locations/{location}/entitlements/{entitlement}/grants/{grant}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`entitlementId`	`string` The `Entitlement` ID. Must not be `null` or empty.
`grantId`	`string` The `Grant` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this GrantName with pattern `projects/{project}/locations/{location}/entitlements/{entitlement}/grants/{grant}`.

FromFolderLocationEntitlementGrant(string, string, string, string)

public static GrantName FromFolderLocationEntitlementGrant(string folderId, string locationId, string entitlementId, string grantId)

Creates a GrantName with the pattern folders/{folder}/locations/{location}/entitlements/{entitlement}/grants/{grant}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`entitlementId`	`string` The `Entitlement` ID. Must not be `null` or empty.
`grantId`	`string` The `Grant` ID. Must not be `null` or empty.

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

FromOrganizationLocationEntitlementGrant(string, string, string, string)

public static GrantName FromOrganizationLocationEntitlementGrant(string organizationId, string locationId, string entitlementId, string grantId)

Creates a GrantName with the pattern organizations/{organization}/locations/{location}/entitlements/{entitlement}/grants/{grant}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`entitlementId`	`string` The `Entitlement` ID. Must not be `null` or empty.
`grantId`	`string` The `Grant` ID. Must not be `null` or empty.

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

FromProjectLocationEntitlementGrant(string, string, string, string)

public static GrantName FromProjectLocationEntitlementGrant(string projectId, string locationId, string entitlementId, string grantId)

Creates a GrantName with the pattern projects/{project}/locations/{location}/entitlements/{entitlement}/grants/{grant}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`entitlementId`	`string` The `Entitlement` ID. Must not be `null` or empty.
`grantId`	`string` The `Grant` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static GrantName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GrantName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/entitlements/{entitlement}/grants/{grant}
folders/{folder}/locations/{location}/entitlements/{entitlement}/grants/{grant}
organizations/{organization}/locations/{location}/entitlements/{entitlement}/grants/{grant}

Parse(string, bool)

public static GrantName Parse(string grantName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/entitlements/{entitlement}/grants/{grant}
folders/{folder}/locations/{location}/entitlements/{entitlement}/grants/{grant}
organizations/{organization}/locations/{location}/entitlements/{entitlement}/grants/{grant}

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

public static bool TryParse(string grantName, out GrantName result)

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

Parameters
Name	Description
`grantName`	`string` The resource name in string form. Must not be `null`.
`result`	`GrantName` When this method returns, the parsed GrantName, 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}/locations/{location}/entitlements/{entitlement}/grants/{grant}
folders/{folder}/locations/{location}/entitlements/{entitlement}/grants/{grant}
organizations/{organization}/locations/{location}/entitlements/{entitlement}/grants/{grant}

TryParse(string, bool, out GrantName)

public static bool TryParse(string grantName, bool allowUnparsed, out GrantName result)

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

Parameters
Name	Description
`grantName`	`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`	`GrantName` When this method returns, the parsed GrantName, 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}/locations/{location}/entitlements/{entitlement}/grants/{grant}
folders/{folder}/locations/{location}/entitlements/{entitlement}/grants/{grant}
organizations/{organization}/locations/{location}/entitlements/{entitlement}/grants/{grant}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(GrantName, GrantName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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