Artifact Registry v1 API - Class ProjectSettingsName (2.1.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class ProjectSettingsName : IResourceName, IEquatable<ProjectSettingsName>

Reference documentation and code samples for the Artifact Registry v1 API class ProjectSettingsName.

Resource name for the ProjectSettings resource.

Inheritance

Object > ProjectSettingsName

Namespace

Google.Cloud.ArtifactRegistry.V1

Assembly

Google.Cloud.ArtifactRegistry.V1.dll

Constructors

ProjectSettingsName(String)

public ProjectSettingsName(string projectId)

Constructs a new instance of a ProjectSettingsName class from the component parts of pattern projects/{project}/projectSettings

Parameter
NameDescription
projectIdString

The Project 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
Boolean

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

The ProjectSettingsName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ProjectSettingsName.ResourceNameType

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)

public static string Format(string projectId)

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

Parameter
NameDescription
projectIdString

The Project ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ProjectSettingsName with pattern projects/{project}/projectSettings.

FormatProject(String)

public static string FormatProject(string projectId)

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

Parameter
NameDescription
projectIdString

The Project ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ProjectSettingsName with pattern projects/{project}/projectSettings.

FromProject(String)

public static ProjectSettingsName FromProject(string projectId)

Creates a ProjectSettingsName with the pattern projects/{project}/projectSettings.

Parameter
NameDescription
projectIdString

The Project ID. Must not be null or empty.

Returns
TypeDescription
ProjectSettingsName

A new instance of ProjectSettingsName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ProjectSettingsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ProjectSettingsName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ProjectSettingsName

A new instance of ProjectSettingsName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static ProjectSettingsName Parse(string projectSettingsName)

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

Parameter
NameDescription
projectSettingsNameString

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

Returns
TypeDescription
ProjectSettingsName

The parsed ProjectSettingsName if successful.

Remarks

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

  • projects/{project}/projectSettings

Parse(String, Boolean)

public static ProjectSettingsName Parse(string projectSettingsName, bool allowUnparsed)

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

Parameters
NameDescription
projectSettingsNameString

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

allowUnparsedBoolean

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
ProjectSettingsName

The parsed ProjectSettingsName if successful.

Remarks

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

  • projects/{project}/projectSettings
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 ProjectSettingsName)

public static bool TryParse(string projectSettingsName, out ProjectSettingsName result)

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

Parameters
NameDescription
projectSettingsNameString

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

resultProjectSettingsName

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

Returns
TypeDescription
Boolean

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}/projectSettings

TryParse(String, Boolean, out ProjectSettingsName)

public static bool TryParse(string projectSettingsName, bool allowUnparsed, out ProjectSettingsName result)

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

Parameters
NameDescription
projectSettingsNameString

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

allowUnparsedBoolean

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.

resultProjectSettingsName

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

Returns
TypeDescription
Boolean

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}/projectSettings
Or may be in any format if allowUnparsed is true.

Operators

Equality(ProjectSettingsName, ProjectSettingsName)

public static bool operator ==(ProjectSettingsName a, ProjectSettingsName b)
Parameters
NameDescription
aProjectSettingsName
bProjectSettingsName
Returns
TypeDescription
Boolean

Inequality(ProjectSettingsName, ProjectSettingsName)

public static bool operator !=(ProjectSettingsName a, ProjectSettingsName b)
Parameters
NameDescription
aProjectSettingsName
bProjectSettingsName
Returns
TypeDescription
Boolean