Cloud Profiler v2 API - Class ProfileName (2.6.0)

public sealed class ProfileName : IResourceName, IEquatable<ProfileName>

Reference documentation and code samples for the Cloud Profiler v2 API class ProfileName.

Resource name for the Profile resource.

Inheritance

object > ProfileName

Namespace

Google.Cloud.Profiler.V2

Assembly

Google.Cloud.Profiler.V2.dll

Constructors

ProfileName(string, string)

public ProfileName(string projectId, string profileId)

Constructs a new instance of a ProfileName class from the component parts of pattern projects/{project}/profiles/{profile}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

profileId string

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

ProfileId

public string ProfileId { get; }

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

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

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

Property Value
Type Description
string

Type

public ProfileName.ResourceNameType Type { get; }

The ProfileName.ResourceNameType of the contained resource name.

Property Value
Type Description
ProfileNameResourceNameType

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

Formats the IDs into the string representation of this ProfileName with pattern projects/{project}/profiles/{profile}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

profileId string

The Profile ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ProfileName with pattern projects/{project}/profiles/{profile}.

FormatProjectProfile(string, string)

public static string FormatProjectProfile(string projectId, string profileId)

Formats the IDs into the string representation of this ProfileName with pattern projects/{project}/profiles/{profile}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

profileId string

The Profile ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ProfileName with pattern projects/{project}/profiles/{profile}.

FromProjectProfile(string, string)

public static ProfileName FromProjectProfile(string projectId, string profileId)

Creates a ProfileName with the pattern projects/{project}/profiles/{profile}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

profileId string

The Profile ID. Must not be null or empty.

Returns
Type Description
ProfileName

A new instance of ProfileName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ProfileName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ProfileName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
ProfileName

A new instance of ProfileName 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 ProfileName Parse(string profileName)

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

Parameter
Name Description
profileName string

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

Returns
Type Description
ProfileName

The parsed ProfileName if successful.

Remarks

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

  • projects/{project}/profiles/{profile}

Parse(string, bool)

public static ProfileName Parse(string profileName, bool allowUnparsed)

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

Parameters
Name Description
profileName 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
ProfileName

The parsed ProfileName if successful.

Remarks

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

  • projects/{project}/profiles/{profile}
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 ProfileName)

public static bool TryParse(string profileName, out ProfileName result)

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

Parameters
Name Description
profileName string

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

result ProfileName

When this method returns, the parsed ProfileName, 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}/profiles/{profile}

TryParse(string, bool, out ProfileName)

public static bool TryParse(string profileName, bool allowUnparsed, out ProfileName result)

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

Parameters
Name Description
profileName 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 ProfileName

When this method returns, the parsed ProfileName, 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}/profiles/{profile}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ProfileName, ProfileName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ProfileName

The first resource name to compare, or null.

b ProfileName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ProfileName

The first resource name to compare, or null.

b ProfileName

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.