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

public sealed class EntitlementName : IResourceName, IEquatable<EntitlementName>

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

Resource name for the Entitlement resource.

Inheritance

object > EntitlementName

Implements

IResourceName, IEquatable EntitlementName

Inherited Members

object.GetType()

Namespace

Google.Cloud.PrivilegedAccessManager.V1

Assembly

Google.Cloud.PrivilegedAccessManager.V1.dll

Constructors

EntitlementName(string, string, string)

public EntitlementName(string projectId, string locationId, string entitlementId)

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

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.

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`

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

The EntitlementName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`EntitlementNameResourceNameType`

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)

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

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

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.

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

FormatFolderLocationEntitlement(string, string, string)

public static string FormatFolderLocationEntitlement(string folderId, string locationId, string entitlementId)

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

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.

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

FormatOrganizationLocationEntitlement(string, string, string)

public static string FormatOrganizationLocationEntitlement(string organizationId, string locationId, string entitlementId)

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

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.

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

FormatProjectLocationEntitlement(string, string, string)

public static string FormatProjectLocationEntitlement(string projectId, string locationId, string entitlementId)

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

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.

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

FromFolderLocationEntitlement(string, string, string)

public static EntitlementName FromFolderLocationEntitlement(string folderId, string locationId, string entitlementId)

Creates a EntitlementName with the pattern folders/{folder}/locations/{location}/entitlements/{entitlement}.

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.

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

FromOrganizationLocationEntitlement(string, string, string)

public static EntitlementName FromOrganizationLocationEntitlement(string organizationId, string locationId, string entitlementId)

Creates a EntitlementName with the pattern organizations/{organization}/locations/{location}/entitlements/{entitlement}.

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.

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

FromProjectLocationEntitlement(string, string, string)

public static EntitlementName FromProjectLocationEntitlement(string projectId, string locationId, string entitlementId)

Creates a EntitlementName with the pattern projects/{project}/locations/{location}/entitlements/{entitlement}.

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.

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

FromUnparsed(UnparsedResourceName)

public static EntitlementName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EntitlementName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

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

Parse(string, bool)

public static EntitlementName Parse(string entitlementName, bool allowUnparsed)

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

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

Remarks

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

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

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

public static bool TryParse(string entitlementName, out EntitlementName result)

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

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

TryParse(string, bool, out EntitlementName)

public static bool TryParse(string entitlementName, bool allowUnparsed, out EntitlementName result)

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

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

Or may be in any format if allowUnparsed is true.

Operators

operator ==(EntitlementName, EntitlementName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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