Cloud Controls Partner v1 API - Class AccessApprovalRequestName (1.0.0-beta01)

public sealed class AccessApprovalRequestName : IResourceName, IEquatable<AccessApprovalRequestName>

Reference documentation and code samples for the Cloud Controls Partner v1 API class AccessApprovalRequestName.

Resource name for the AccessApprovalRequest resource.

Inheritance

object > AccessApprovalRequestName

Implements

IResourceName, IEquatable AccessApprovalRequestName

Inherited Members

object.GetType()

Namespace

Google.Cloud.CloudControlsPartner.V1

Assembly

Google.Cloud.CloudControlsPartner.V1.dll

Constructors

AccessApprovalRequestName(string, string, string, string, string)

public AccessApprovalRequestName(string organizationId, string locationId, string customerId, string workloadId, string accessApprovalRequestId)

Constructs a new instance of a AccessApprovalRequestName class from the component parts of pattern organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/accessApprovalRequests/{access_approval_request}

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.
`customerId`	`string` The `Customer` ID. Must not be `null` or empty.
`workloadId`	`string` The `Workload` ID. Must not be `null` or empty.
`accessApprovalRequestId`	`string` The `AccessApprovalRequest` ID. Must not be `null` or empty.

Properties

AccessApprovalRequestId

public string AccessApprovalRequestId { get; }

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

Property Value
Type	Description
`string`

CustomerId

public string CustomerId { get; }

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

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. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

OrganizationId

public string OrganizationId { get; }

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

Property Value
Type	Description
`string`

Type

public AccessApprovalRequestName.ResourceNameType Type { get; }

The AccessApprovalRequestName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AccessApprovalRequestNameResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type	Description
`UnparsedResourceName`

WorkloadId

public string WorkloadId { get; }

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

Property Value
Type	Description
`string`

Methods

Format(string, string, string, string, string)

public static string Format(string organizationId, string locationId, string customerId, string workloadId, string accessApprovalRequestId)

Formats the IDs into the string representation of this AccessApprovalRequestName with pattern organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/accessApprovalRequests/{access_approval_request} .

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.
`customerId`	`string` The `Customer` ID. Must not be `null` or empty.
`workloadId`	`string` The `Workload` ID. Must not be `null` or empty.
`accessApprovalRequestId`	`string` The `AccessApprovalRequest` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AccessApprovalRequestName with pattern `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/accessApprovalRequests/{access_approval_request}` .

FormatOrganizationLocationCustomerWorkloadAccessApprovalRequest(string, string, string, string, string)

public static string FormatOrganizationLocationCustomerWorkloadAccessApprovalRequest(string organizationId, string locationId, string customerId, string workloadId, string accessApprovalRequestId)

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.
`customerId`	`string` The `Customer` ID. Must not be `null` or empty.
`workloadId`	`string` The `Workload` ID. Must not be `null` or empty.
`accessApprovalRequestId`	`string` The `AccessApprovalRequest` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AccessApprovalRequestName with pattern `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/accessApprovalRequests/{access_approval_request}` .

FromOrganizationLocationCustomerWorkloadAccessApprovalRequest(string, string, string, string, string)

public static AccessApprovalRequestName FromOrganizationLocationCustomerWorkloadAccessApprovalRequest(string organizationId, string locationId, string customerId, string workloadId, string accessApprovalRequestId)

Creates a AccessApprovalRequestName with the pattern organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/accessApprovalRequests/{access_approval_request} .

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.
`customerId`	`string` The `Customer` ID. Must not be `null` or empty.
`workloadId`	`string` The `Workload` ID. Must not be `null` or empty.
`accessApprovalRequestId`	`string` The `AccessApprovalRequest` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static AccessApprovalRequestName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AccessApprovalRequestName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/accessApprovalRequests/{access_approval_request}

Parse(string, bool)

public static AccessApprovalRequestName Parse(string accessApprovalRequestName, bool allowUnparsed)

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

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

Remarks

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

organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/accessApprovalRequests/{access_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

object.ToString()

TryParse(string, out AccessApprovalRequestName)

public static bool TryParse(string accessApprovalRequestName, out AccessApprovalRequestName result)

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

Parameters
Name	Description
`accessApprovalRequestName`	`string` The resource name in string form. Must not be `null`.
`result`	`AccessApprovalRequestName` When this method returns, the parsed AccessApprovalRequestName, 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:

organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/accessApprovalRequests/{access_approval_request}

TryParse(string, bool, out AccessApprovalRequestName)

public static bool TryParse(string accessApprovalRequestName, bool allowUnparsed, out AccessApprovalRequestName result)

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

Parameters
Name	Description
`accessApprovalRequestName`	`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`	`AccessApprovalRequestName` When this method returns, the parsed AccessApprovalRequestName, 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:

organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/accessApprovalRequests/{access_approval_request}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AccessApprovalRequestName, AccessApprovalRequestName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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