Apigee Registry v1 API - Class ArtifactName (1.0.0-beta06)

public sealed class ArtifactName : IResourceName, IEquatable<ArtifactName>

Reference documentation and code samples for the Apigee Registry v1 API class ArtifactName.

Resource name for the Artifact resource.

Inheritance

object > ArtifactName

Namespace

Google.Cloud.ApigeeRegistry.V1

Assembly

Google.Cloud.ApigeeRegistry.V1.dll

Constructors

ArtifactName(string, string, string)

public ArtifactName(string projectId, string locationId, string artifactId)

Constructs a new instance of a ArtifactName class from the component parts of pattern projects/{project}/locations/{location}/artifacts/{artifact}

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.

artifactId string

The Artifact ID. Must not be null or empty.

Properties

ApiId

public string ApiId { get; }

The Api ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

ArtifactId

public string ArtifactId { get; }

The Artifact ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

DeploymentId

public string DeploymentId { get; }

The Deployment ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

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

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

SpecId

public string SpecId { get; }

The Spec ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Type

public ArtifactName.ResourceNameType Type { get; }

The ArtifactName.ResourceNameType of the contained resource name.

Property Value
Type Description
ArtifactNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

VersionId

public string VersionId { get; }

The Version ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Methods

Format(string, string, string)

public static string Format(string projectId, string locationId, string artifactId)

Formats the IDs into the string representation of this ArtifactName with pattern projects/{project}/locations/{location}/artifacts/{artifact}.

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.

artifactId string

The Artifact ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ArtifactName with pattern projects/{project}/locations/{location}/artifacts/{artifact}.

FormatProjectLocationApiArtifact(string, string, string, string)

public static string FormatProjectLocationApiArtifact(string projectId, string locationId, string apiId, string artifactId)

Formats the IDs into the string representation of this ArtifactName with pattern projects/{project}/locations/{location}/apis/{api}/artifacts/{artifact}.

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.

apiId string

The Api ID. Must not be null or empty.

artifactId string

The Artifact ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ArtifactName with pattern projects/{project}/locations/{location}/apis/{api}/artifacts/{artifact}.

FormatProjectLocationApiDeploymentArtifact(string, string, string, string, string)

public static string FormatProjectLocationApiDeploymentArtifact(string projectId, string locationId, string apiId, string deploymentId, string artifactId)

Formats the IDs into the string representation of this ArtifactName with pattern projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}/artifacts/{artifact}.

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.

apiId string

The Api ID. Must not be null or empty.

deploymentId string

The Deployment ID. Must not be null or empty.

artifactId string

The Artifact ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ArtifactName with pattern projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}/artifacts/{artifact}.

FormatProjectLocationApiVersionArtifact(string, string, string, string, string)

public static string FormatProjectLocationApiVersionArtifact(string projectId, string locationId, string apiId, string versionId, string artifactId)

Formats the IDs into the string representation of this ArtifactName with pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/artifacts/{artifact}.

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.

apiId string

The Api ID. Must not be null or empty.

versionId string

The Version ID. Must not be null or empty.

artifactId string

The Artifact ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ArtifactName with pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/artifacts/{artifact}.

FormatProjectLocationApiVersionSpecArtifact(string, string, string, string, string, string)

public static string FormatProjectLocationApiVersionSpecArtifact(string projectId, string locationId, string apiId, string versionId, string specId, string artifactId)

Formats the IDs into the string representation of this ArtifactName with pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}/artifacts/{artifact} .

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.

apiId string

The Api ID. Must not be null or empty.

versionId string

The Version ID. Must not be null or empty.

specId string

The Spec ID. Must not be null or empty.

artifactId string

The Artifact ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ArtifactName with pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}/artifacts/{artifact} .

FormatProjectLocationArtifact(string, string, string)

public static string FormatProjectLocationArtifact(string projectId, string locationId, string artifactId)

Formats the IDs into the string representation of this ArtifactName with pattern projects/{project}/locations/{location}/artifacts/{artifact}.

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.

artifactId string

The Artifact ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ArtifactName with pattern projects/{project}/locations/{location}/artifacts/{artifact}.

FromProjectLocationApiArtifact(string, string, string, string)

public static ArtifactName FromProjectLocationApiArtifact(string projectId, string locationId, string apiId, string artifactId)

Creates a ArtifactName with the pattern projects/{project}/locations/{location}/apis/{api}/artifacts/{artifact}.

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.

apiId string

The Api ID. Must not be null or empty.

artifactId string

The Artifact ID. Must not be null or empty.

Returns
Type Description
ArtifactName

A new instance of ArtifactName constructed from the provided ids.

FromProjectLocationApiDeploymentArtifact(string, string, string, string, string)

public static ArtifactName FromProjectLocationApiDeploymentArtifact(string projectId, string locationId, string apiId, string deploymentId, string artifactId)

Creates a ArtifactName with the pattern projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}/artifacts/{artifact}.

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.

apiId string

The Api ID. Must not be null or empty.

deploymentId string

The Deployment ID. Must not be null or empty.

artifactId string

The Artifact ID. Must not be null or empty.

Returns
Type Description
ArtifactName

A new instance of ArtifactName constructed from the provided ids.

FromProjectLocationApiVersionArtifact(string, string, string, string, string)

public static ArtifactName FromProjectLocationApiVersionArtifact(string projectId, string locationId, string apiId, string versionId, string artifactId)

Creates a ArtifactName with the pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/artifacts/{artifact}.

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.

apiId string

The Api ID. Must not be null or empty.

versionId string

The Version ID. Must not be null or empty.

artifactId string

The Artifact ID. Must not be null or empty.

Returns
Type Description
ArtifactName

A new instance of ArtifactName constructed from the provided ids.

FromProjectLocationApiVersionSpecArtifact(string, string, string, string, string, string)

public static ArtifactName FromProjectLocationApiVersionSpecArtifact(string projectId, string locationId, string apiId, string versionId, string specId, string artifactId)

Creates a ArtifactName with the pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}/artifacts/{artifact} .

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.

apiId string

The Api ID. Must not be null or empty.

versionId string

The Version ID. Must not be null or empty.

specId string

The Spec ID. Must not be null or empty.

artifactId string

The Artifact ID. Must not be null or empty.

Returns
Type Description
ArtifactName

A new instance of ArtifactName constructed from the provided ids.

FromProjectLocationArtifact(string, string, string)

public static ArtifactName FromProjectLocationArtifact(string projectId, string locationId, string artifactId)

Creates a ArtifactName with the pattern projects/{project}/locations/{location}/artifacts/{artifact}.

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.

artifactId string

The Artifact ID. Must not be null or empty.

Returns
Type Description
ArtifactName

A new instance of ArtifactName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ArtifactName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ArtifactName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
ArtifactName

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

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

Parameter
Name Description
artifactName string

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

Returns
Type Description
ArtifactName

The parsed ArtifactName if successful.

Remarks

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

  • projects/{project}/locations/{location}/artifacts/{artifact}
  • projects/{project}/locations/{location}/apis/{api}/artifacts/{artifact}
  • projects/{project}/locations/{location}/apis/{api}/versions/{version}/artifacts/{artifact}
  • projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}/artifacts/{artifact}
  • projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}/artifacts/{artifact}

Parse(string, bool)

public static ArtifactName Parse(string artifactName, bool allowUnparsed)

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

Parameters
Name Description
artifactName 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
ArtifactName

The parsed ArtifactName if successful.

Remarks

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

  • projects/{project}/locations/{location}/artifacts/{artifact}
  • projects/{project}/locations/{location}/apis/{api}/artifacts/{artifact}
  • projects/{project}/locations/{location}/apis/{api}/versions/{version}/artifacts/{artifact}
  • projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}/artifacts/{artifact}
  • projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}/artifacts/{artifact}
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 ArtifactName)

public static bool TryParse(string artifactName, out ArtifactName result)

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

Parameters
Name Description
artifactName string

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

result ArtifactName

When this method returns, the parsed ArtifactName, 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}/locations/{location}/artifacts/{artifact}
  • projects/{project}/locations/{location}/apis/{api}/artifacts/{artifact}
  • projects/{project}/locations/{location}/apis/{api}/versions/{version}/artifacts/{artifact}
  • projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}/artifacts/{artifact}
  • projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}/artifacts/{artifact}

TryParse(string, bool, out ArtifactName)

public static bool TryParse(string artifactName, bool allowUnparsed, out ArtifactName result)

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

Parameters
Name Description
artifactName 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 ArtifactName

When this method returns, the parsed ArtifactName, 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}/locations/{location}/artifacts/{artifact}
  • projects/{project}/locations/{location}/apis/{api}/artifacts/{artifact}
  • projects/{project}/locations/{location}/apis/{api}/versions/{version}/artifacts/{artifact}
  • projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}/artifacts/{artifact}
  • projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}/artifacts/{artifact}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ArtifactName, ArtifactName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ArtifactName

The first resource name to compare, or null.

b ArtifactName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ArtifactName

The first resource name to compare, or null.

b ArtifactName

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.