Cloud Security Compliance v1 API - Class CmEnrollmentName (1.0.0-beta04)

Version latest

• 1.0.0-beta04 (latest)
• 1.0.0-beta03

public sealed class CmEnrollmentName : IResourceName, IEquatable<CmEnrollmentName>

Reference documentation and code samples for the Cloud Security Compliance v1 API class CmEnrollmentName.

Resource name for the CmEnrollment resource.

Inheritance

object > CmEnrollmentName

Implements

IResourceName, IEquatableCmEnrollmentName

Inherited Members

object.GetType()

Namespace

Google.Cloud.CloudSecurityCompliance.V1

Assembly

Google.Cloud.CloudSecurityCompliance.V1.dll

Constructors

CmEnrollmentName(string, string)

public CmEnrollmentName(string organizationId, string locationId)

Constructs a new instance of a CmEnrollmentName class from the component parts of pattern organizations/{organization}/locations/{location}/cmEnrollment

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.

Properties

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

The CmEnrollmentName.ResourceNameType of the contained resource name.

Property Value
Type	Description
CmEnrollmentNameResourceNameType

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

Formats the IDs into the string representation of this CmEnrollmentName with pattern organizations/{organization}/locations/{location}/cmEnrollment.

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.

Returns
Type	Description
string	The string representation of this CmEnrollmentName with pattern organizations/{organization}/locations/{location}/cmEnrollment.

FormatOrganizationLocation(string, string)

public static string FormatOrganizationLocation(string organizationId, string locationId)

Formats the IDs into the string representation of this CmEnrollmentName with pattern organizations/{organization}/locations/{location}/cmEnrollment.

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.

Returns
Type	Description
string	The string representation of this CmEnrollmentName with pattern organizations/{organization}/locations/{location}/cmEnrollment.

FormatProjectLocation(string, string)

public static string FormatProjectLocation(string projectId, string locationId)

Formats the IDs into the string representation of this CmEnrollmentName with pattern projects/{project}/locations/{location}/cmEnrollment.

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.

Returns
Type	Description
string	The string representation of this CmEnrollmentName with pattern projects/{project}/locations/{location}/cmEnrollment.

FromOrganizationLocation(string, string)

public static CmEnrollmentName FromOrganizationLocation(string organizationId, string locationId)

Creates a CmEnrollmentName with the pattern organizations/{organization}/locations/{location}/cmEnrollment.

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.

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

FromProjectLocation(string, string)

public static CmEnrollmentName FromProjectLocation(string projectId, string locationId)

Creates a CmEnrollmentName with the pattern projects/{project}/locations/{location}/cmEnrollment.

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.

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

FromUnparsed(UnparsedResourceName)

public static CmEnrollmentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CmEnrollmentName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
CmEnrollmentName	The parsed CmEnrollmentName if successful.

Remarks

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

• organizations/{organization}/locations/{location}/cmEnrollment
• projects/{project}/locations/{location}/cmEnrollment

Parse(string, bool)

public static CmEnrollmentName Parse(string cmEnrollmentName, bool allowUnparsed)

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

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

Remarks

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

• organizations/{organization}/locations/{location}/cmEnrollment
• projects/{project}/locations/{location}/cmEnrollment

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

public static bool TryParse(string cmEnrollmentName, out CmEnrollmentName result)

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

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

TryParse(string, bool, out CmEnrollmentName)

public static bool TryParse(string cmEnrollmentName, bool allowUnparsed, out CmEnrollmentName result)

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

Parameters
Name	Description
cmEnrollmentName	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	CmEnrollmentName When this method returns, the parsed CmEnrollmentName, 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}/cmEnrollment
• projects/{project}/locations/{location}/cmEnrollment

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CmEnrollmentName, CmEnrollmentName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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