Retail v2 API - Class BranchName (2.5.0)

public sealed class BranchName : IResourceName, IEquatable<BranchName>

Reference documentation and code samples for the Retail v2 API class BranchName.

Resource name for the Branch resource.

Inheritance

object > BranchName

Namespace

GoogleCloudGoogle.Cloud.RetailV2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

BranchName(string, string, string, string)

public BranchName(string projectId, string locationId, string catalogId, string branchId)

Constructs a new instance of a BranchName class from the component parts of pattern projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

catalogIdstring

The Catalog ID. Must not be null or empty.

branchIdstring

The Branch ID. Must not be null or empty.

Properties

BranchId

public string BranchId { get; }

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

Property Value
TypeDescription
string

CatalogId

public string CatalogId { get; }

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

Property Value
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
bool

LocationId

public string LocationId { get; }

The Location 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 BranchName.ResourceNameType Type { get; }

The BranchName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
BranchNameResourceNameType

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

public static string Format(string projectId, string locationId, string catalogId, string branchId)

Formats the IDs into the string representation of this BranchName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

catalogIdstring

The Catalog ID. Must not be null or empty.

branchIdstring

The Branch ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this BranchName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}.

FormatProjectLocationCatalogBranch(string, string, string, string)

public static string FormatProjectLocationCatalogBranch(string projectId, string locationId, string catalogId, string branchId)

Formats the IDs into the string representation of this BranchName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

catalogIdstring

The Catalog ID. Must not be null or empty.

branchIdstring

The Branch ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this BranchName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}.

FromProjectLocationCatalogBranch(string, string, string, string)

public static BranchName FromProjectLocationCatalogBranch(string projectId, string locationId, string catalogId, string branchId)

Creates a BranchName with the pattern projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

catalogIdstring

The Catalog ID. Must not be null or empty.

branchIdstring

The Branch ID. Must not be null or empty.

Returns
TypeDescription
BranchName

A new instance of BranchName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static BranchName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BranchName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
BranchName

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

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

Parameter
NameDescription
branchNamestring

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

Returns
TypeDescription
BranchName

The parsed BranchName if successful.

Remarks

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

  • projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}

Parse(string, bool)

public static BranchName Parse(string branchName, bool allowUnparsed)

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

Parameters
NameDescription
branchNamestring

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
BranchName

The parsed BranchName if successful.

Remarks

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

  • projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}
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 BranchName)

public static bool TryParse(string branchName, out BranchName result)

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

Parameters
NameDescription
branchNamestring

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

resultBranchName

When this method returns, the parsed BranchName, 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}/locations/{location}/catalogs/{catalog}/branches/{branch}

TryParse(string, bool, out BranchName)

public static bool TryParse(string branchName, bool allowUnparsed, out BranchName result)

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

Parameters
NameDescription
branchNamestring

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.

resultBranchName

When this method returns, the parsed BranchName, 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}/locations/{location}/catalogs/{catalog}/branches/{branch}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(BranchName, BranchName)

public static bool operator ==(BranchName a, BranchName b)
Parameters
NameDescription
aBranchName
bBranchName
Returns
TypeDescription
bool

operator !=(BranchName, BranchName)

public static bool operator !=(BranchName a, BranchName b)
Parameters
NameDescription
aBranchName
bBranchName
Returns
TypeDescription
bool