Cloud Profiler v2 API - Class ProfileName (2.3.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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

profileIdstring

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
TypeDescription
bool

ProfileId

public string ProfileId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

Type

public ProfileName.ResourceNameType Type { get; }

The ProfileName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ProfileNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

profileIdstring

The Profile ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

profileIdstring

The Profile ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

profileIdstring

The Profile ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ProfileName

A new instance of ProfileName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static ProfileName Parse(string profileName)

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

Parameter
NameDescription
profileNamestring

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

Returns
TypeDescription
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
NameDescription
profileNamestring

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

allowUnparsedbool

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
TypeDescription
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
TypeDescription
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
NameDescription
profileNamestring

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

resultProfileName

When this method returns, the parsed ProfileName, or null if parsing failed.

Returns
TypeDescription
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
NameDescription
profileNamestring

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

allowUnparsedbool

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.

resultProfileName

When this method returns, the parsed ProfileName, or null if parsing failed.

Returns
TypeDescription
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)
Parameters
NameDescription
aProfileName
bProfileName
Returns
TypeDescription
bool

operator !=(ProfileName, ProfileName)

public static bool operator !=(ProfileName a, ProfileName b)
Parameters
NameDescription
aProfileName
bProfileName
Returns
TypeDescription
bool