Artifact Registry v1 API - Class FileName (2.6.0)

public sealed class FileName : IResourceName, IEquatable<FileName>

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

Resource name for the File resource.

Inheritance

object > FileName

Implements

IResourceName, IEquatable FileName

Inherited Members

object.GetType()

Namespace

Google.Cloud.ArtifactRegistry.V1

Assembly

Google.Cloud.ArtifactRegistry.V1.dll

Constructors

FileName(string, string, string, string)

public FileName(string projectId, string locationId, string repositoryId, string fileId)

Constructs a new instance of a FileName class from the component parts of pattern projects/{project}/locations/{location}/repositories/{repository}/files/{file}

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.
`repositoryId`	`string` The `Repository` ID. Must not be `null` or empty.
`fileId`	`string` The `File` ID. Must not be `null` or empty.

Properties

FileId

public string FileId { get; }

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

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. 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`

RepositoryId

public string RepositoryId { get; }

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

Property Value
Type	Description
`string`

Type

public FileName.ResourceNameType Type { get; }

The FileName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`FileNameResourceNameType`

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

public static string Format(string projectId, string locationId, string repositoryId, string fileId)

Formats the IDs into the string representation of this FileName with pattern projects/{project}/locations/{location}/repositories/{repository}/files/{file}.

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.
`repositoryId`	`string` The `Repository` ID. Must not be `null` or empty.
`fileId`	`string` The `File` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this FileName with pattern `projects/{project}/locations/{location}/repositories/{repository}/files/{file}`.

FormatProjectLocationRepositoryFile(string, string, string, string)

public static string FormatProjectLocationRepositoryFile(string projectId, string locationId, string repositoryId, string fileId)

Formats the IDs into the string representation of this FileName with pattern projects/{project}/locations/{location}/repositories/{repository}/files/{file}.

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.
`repositoryId`	`string` The `Repository` ID. Must not be `null` or empty.
`fileId`	`string` The `File` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this FileName with pattern `projects/{project}/locations/{location}/repositories/{repository}/files/{file}`.

FromProjectLocationRepositoryFile(string, string, string, string)

public static FileName FromProjectLocationRepositoryFile(string projectId, string locationId, string repositoryId, string fileId)

Creates a FileName with the pattern projects/{project}/locations/{location}/repositories/{repository}/files/{file}.

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.
`repositoryId`	`string` The `Repository` ID. Must not be `null` or empty.
`fileId`	`string` The `File` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static FileName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FileName containing an unparsed resource name.

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

Returns
Type	Description
`FileName`	A new instance of FileName 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 FileName Parse(string fileName)

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

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

Returns
Type	Description
`FileName`	The parsed FileName if successful.

Remarks

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

projects/{project}/locations/{location}/repositories/{repository}/files/{file}

Parse(string, bool)

public static FileName Parse(string fileName, bool allowUnparsed)

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

Parameters
Name	Description
`fileName`	`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
`FileName`	The parsed FileName if successful.

Remarks

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

projects/{project}/locations/{location}/repositories/{repository}/files/{file}

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

public static bool TryParse(string fileName, out FileName result)

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

Parameters
Name	Description
`fileName`	`string` The resource name in string form. Must not be `null`.
`result`	`FileName` When this method returns, the parsed FileName, 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}/repositories/{repository}/files/{file}

TryParse(string, bool, out FileName)

public static bool TryParse(string fileName, bool allowUnparsed, out FileName result)

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

Parameters
Name	Description
`fileName`	`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`	`FileName` When this method returns, the parsed FileName, 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}/repositories/{repository}/files/{file}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(FileName, FileName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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