KMS Inventory v1 API - Class ProtectedResourceScopeName (1.6.0)

Version latest

• 1.6.0 (latest)
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class ProtectedResourceScopeName : IResourceName, IEquatable<ProtectedResourceScopeName>

Reference documentation and code samples for the KMS Inventory v1 API class ProtectedResourceScopeName.

Resource name for the ProtectedResourceScope resource.

Inheritance

object > ProtectedResourceScopeName

Implements

IResourceName, IEquatableProtectedResourceScopeName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Kms.Inventory.V1

Assembly

Google.Cloud.Kms.Inventory.V1.dll

Constructors

ProtectedResourceScopeName(string)

public ProtectedResourceScopeName(string organizationId)

Constructs a new instance of a ProtectedResourceScopeName class from the component parts of pattern organizations/{organization}/protectedResourceScope

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

Properties

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

The ProtectedResourceScopeName.ResourceNameType of the contained resource name.

Property Value
Type	Description
ProtectedResourceScopeNameResourceNameType

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

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

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

Returns
Type	Description
string	The string representation of this ProtectedResourceScopeName with pattern organizations/{organization}/protectedResourceScope.

FormatOrganization(string)

public static string FormatOrganization(string organizationId)

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

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

Returns
Type	Description
string	The string representation of this ProtectedResourceScopeName with pattern organizations/{organization}/protectedResourceScope.

FormatProject(string)

public static string FormatProject(string projectId)

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

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

Returns
Type	Description
string	The string representation of this ProtectedResourceScopeName with pattern projects/{project}/protectedResourceScope.

FromOrganization(string)

public static ProtectedResourceScopeName FromOrganization(string organizationId)

Creates a ProtectedResourceScopeName with the pattern organizations/{organization}/protectedResourceScope.

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

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

FromProject(string)

public static ProtectedResourceScopeName FromProject(string projectId)

Creates a ProtectedResourceScopeName with the pattern projects/{project}/protectedResourceScope.

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

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

FromUnparsed(UnparsedResourceName)

public static ProtectedResourceScopeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ProtectedResourceScopeName containing an unparsed resource name.

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

Returns
Type	Description
ProtectedResourceScopeName	A new instance of ProtectedResourceScopeName 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 ProtectedResourceScopeName Parse(string protectedResourceScopeName)

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

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

Returns
Type	Description
ProtectedResourceScopeName	The parsed ProtectedResourceScopeName if successful.

Remarks

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

• organizations/{organization}/protectedResourceScope
• projects/{project}/protectedResourceScope

Parse(string, bool)

public static ProtectedResourceScopeName Parse(string protectedResourceScopeName, bool allowUnparsed)

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

Parameters
Name	Description
protectedResourceScopeName	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
ProtectedResourceScopeName	The parsed ProtectedResourceScopeName if successful.

Remarks

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

• organizations/{organization}/protectedResourceScope
• projects/{project}/protectedResourceScope

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

public static bool TryParse(string protectedResourceScopeName, out ProtectedResourceScopeName result)

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

Parameters
Name	Description
protectedResourceScopeName	string The resource name in string form. Must not be null.
result	ProtectedResourceScopeName When this method returns, the parsed ProtectedResourceScopeName, 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}/protectedResourceScope
• projects/{project}/protectedResourceScope

TryParse(string, bool, out ProtectedResourceScopeName)

public static bool TryParse(string protectedResourceScopeName, bool allowUnparsed, out ProtectedResourceScopeName result)

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

Parameters
Name	Description
protectedResourceScopeName	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	ProtectedResourceScopeName When this method returns, the parsed ProtectedResourceScopeName, 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}/protectedResourceScope
• projects/{project}/protectedResourceScope

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ProtectedResourceScopeName, ProtectedResourceScopeName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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