Access Approval v1 API - Class ApprovalRequestName (2.5.0) 

public sealed class ApprovalRequestName : IResourceName, IEquatable<ApprovalRequestName>

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

Resource name for the ApprovalRequest resource.

Inheritance

object > ApprovalRequestName

Namespace

Google.Cloud.AccessApproval.V1

Assembly

Google.Cloud.AccessApproval.V1.dll

Constructors

ApprovalRequestName(string, string)

public ApprovalRequestName(string projectId, string approvalRequestId)

Constructs a new instance of a ApprovalRequestName class from the component parts of pattern projects/{project}/approvalRequests/{approval_request}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
approvalRequestId string

The ApprovalRequest ID. Must not be null or empty.

Properties

ApprovalRequestId

public string ApprovalRequestId { get; }

The ApprovalRequest 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

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

The ApprovalRequestName.ResourceNameType of the contained resource name.

Property Value
Type Description
ApprovalRequestNameResourceNameType

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)

public static string Format(string projectId, string approvalRequestId)

Formats the IDs into the string representation of this ApprovalRequestName with pattern projects/{project}/approvalRequests/{approval_request}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
approvalRequestId string

The ApprovalRequest ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ApprovalRequestName with pattern projects/{project}/approvalRequests/{approval_request}.

FormatFolderApprovalRequest(string, string)

public static string FormatFolderApprovalRequest(string folderId, string approvalRequestId)

Formats the IDs into the string representation of this ApprovalRequestName with pattern folders/{folder}/approvalRequests/{approval_request}.

Parameters
Name Description
folderId string

The Folder ID. Must not be null or empty.
approvalRequestId string

The ApprovalRequest ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ApprovalRequestName with pattern folders/{folder}/approvalRequests/{approval_request}.

FormatOrganizationApprovalRequest(string, string)

public static string FormatOrganizationApprovalRequest(string organizationId, string approvalRequestId)

Formats the IDs into the string representation of this ApprovalRequestName with pattern organizations/{organization}/approvalRequests/{approval_request}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
approvalRequestId string

The ApprovalRequest ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ApprovalRequestName with pattern organizations/{organization}/approvalRequests/{approval_request}.

FormatProjectApprovalRequest(string, string)

public static string FormatProjectApprovalRequest(string projectId, string approvalRequestId)

Formats the IDs into the string representation of this ApprovalRequestName with pattern projects/{project}/approvalRequests/{approval_request}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
approvalRequestId string

The ApprovalRequest ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ApprovalRequestName with pattern projects/{project}/approvalRequests/{approval_request}.

FromFolderApprovalRequest(string, string)

public static ApprovalRequestName FromFolderApprovalRequest(string folderId, string approvalRequestId)

Creates a ApprovalRequestName with the pattern folders/{folder}/approvalRequests/{approval_request}.

Parameters
Name Description
folderId string

The Folder ID. Must not be null or empty.
approvalRequestId string

The ApprovalRequest ID. Must not be null or empty.
Returns
Type Description
ApprovalRequestName

A new instance of ApprovalRequestName constructed from the provided ids.

FromOrganizationApprovalRequest(string, string)

public static ApprovalRequestName FromOrganizationApprovalRequest(string organizationId, string approvalRequestId)

Creates a ApprovalRequestName with the pattern organizations/{organization}/approvalRequests/{approval_request}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
approvalRequestId string

The ApprovalRequest ID. Must not be null or empty.
Returns
Type Description
ApprovalRequestName

A new instance of ApprovalRequestName constructed from the provided ids.

FromProjectApprovalRequest(string, string)

public static ApprovalRequestName FromProjectApprovalRequest(string projectId, string approvalRequestId)

Creates a ApprovalRequestName with the pattern projects/{project}/approvalRequests/{approval_request}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
approvalRequestId string

The ApprovalRequest ID. Must not be null or empty.
Returns
Type Description
ApprovalRequestName

A new instance of ApprovalRequestName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ApprovalRequestName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ApprovalRequestName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
ApprovalRequestName

A new instance of ApprovalRequestName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static ApprovalRequestName Parse(string approvalRequestName)

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

Parameter
Name Description
approvalRequestName string

The resource name in string form. Must not be null.
Returns
Type Description
ApprovalRequestName

The parsed ApprovalRequestName if successful.
Remarks

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

  • projects/{project}/approvalRequests/{approval_request}
  • folders/{folder}/approvalRequests/{approval_request}
  • organizations/{organization}/approvalRequests/{approval_request}

Parse(string, bool)

public static ApprovalRequestName Parse(string approvalRequestName, bool allowUnparsed)

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

Parameters
Name Description
approvalRequestName 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
ApprovalRequestName

The parsed ApprovalRequestName if successful.
Remarks

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

  • projects/{project}/approvalRequests/{approval_request}
  • folders/{folder}/approvalRequests/{approval_request}
  • organizations/{organization}/approvalRequests/{approval_request}
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

TryParse(string, out ApprovalRequestName)

public static bool TryParse(string approvalRequestName, out ApprovalRequestName result)

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

Parameters
Name Description
approvalRequestName string

The resource name in string form. Must not be null.
result ApprovalRequestName

When this method returns, the parsed ApprovalRequestName, 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}/approvalRequests/{approval_request}
  • folders/{folder}/approvalRequests/{approval_request}
  • organizations/{organization}/approvalRequests/{approval_request}

TryParse(string, bool, out ApprovalRequestName)

public static bool TryParse(string approvalRequestName, bool allowUnparsed, out ApprovalRequestName result)

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

Parameters
Name Description
approvalRequestName 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 ApprovalRequestName

When this method returns, the parsed ApprovalRequestName, 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}/approvalRequests/{approval_request}
  • folders/{folder}/approvalRequests/{approval_request}
  • organizations/{organization}/approvalRequests/{approval_request}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ApprovalRequestName, ApprovalRequestName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ApprovalRequestName

The first resource name to compare, or null.
b ApprovalRequestName

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 !=(ApprovalRequestName, ApprovalRequestName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ApprovalRequestName

The first resource name to compare, or null.
b ApprovalRequestName

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.