Class BranchName (1.5.0)

Version 1.5.0

• 2.12.0 (latest)
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class BranchName : IResourceName, IEquatable<BranchName>

Resource name for the Branch resource.

Inheritance

Object > BranchName

Implements

IResourceName, IEquatable<BranchName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Retail.V2

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
Name	Description
projectId	String The Project ID. Must not be null or empty.
locationId	String The Location ID. Must not be null or empty.
catalogId	String The Catalog ID. Must not be null or empty.
branchId	String 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
Type	Description
String

CatalogId

public string CatalogId { get; }

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

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

Type

public BranchName.ResourceNameType Type { get; }

The BranchName.ResourceNameType of the contained resource name.

Property Value
Type	Description
BranchName.ResourceNameType

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

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

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.
catalogId	String The Catalog ID. Must not be null or empty.
branchId	String The Branch ID. Must not be null or empty.

Returns
Type	Description
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
Name	Description
projectId	String The Project ID. Must not be null or empty.
locationId	String The Location ID. Must not be null or empty.
catalogId	String The Catalog ID. Must not be null or empty.
branchId	String The Branch ID. Must not be null or empty.

Returns
Type	Description
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
Name	Description
projectId	String The Project ID. Must not be null or empty.
locationId	String The Location ID. Must not be null or empty.
catalogId	String The Catalog ID. Must not be null or empty.
branchId	String The Branch ID. Must not be null or empty.

Returns
Type	Description
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
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
BranchName	A new instance of BranchName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
Int32

Overrides

Object.GetHashCode()

Parse(String)

public static BranchName Parse(string branchName)

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

Parameter
Name	Description
branchName	String The resource name in string form. Must not be null.

Returns
Type	Description
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, Boolean)

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
Name	Description
branchName	String The resource name in string form. Must not be null.
allowUnparsed	Boolean 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
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
Type	Description
String	The string representation of the resource name.

Overrides

Object.ToString()

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
Name	Description
branchName	String The resource name in string form. Must not be null.
result	BranchName When this method returns, the parsed BranchName, or null if parsing failed.

Returns
Type	Description
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}/locations/{location}/catalogs/{catalog}/branches/{branch}

TryParse(String, Boolean, 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
Name	Description
branchName	String The resource name in string form. Must not be null.
allowUnparsed	Boolean 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	BranchName When this method returns, the parsed BranchName, or null if parsing failed.

Returns
Type	Description
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}/locations/{location}/catalogs/{catalog}/branches/{branch}

Or may be in any format if allowUnparsed is true.

Operators

Equality(BranchName, BranchName)

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

Parameters
Name	Description
a	BranchName
b	BranchName

Returns
Type	Description
Boolean

Inequality(BranchName, BranchName)

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

Parameters
Name	Description
a	BranchName
b	BranchName

Returns
Type	Description
Boolean