Class BranchName

Resource name for the Branch resource.

Inheritance

System.Object

BranchName

Implements

IResourceName

System.IEquatable<BranchName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Cloud.Retail.V2

Assembly: Google.Cloud.Retail.V2.dll

Syntax

public sealed class BranchName : IResourceName, IEquatable<BranchName>

Constructors

BranchName(String, String, String, String)

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

Declaration

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

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	locationId	The Location ID. Must not be null or empty.
System.String	catalogId	The Catalog ID. Must not be null or empty.
System.String	branchId	The Branch ID. Must not be null or empty.

Properties

BranchId

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

Declaration

public string BranchId { get; }

Property Value

Type	Description
System.String

CatalogId

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

Declaration

public string CatalogId { get; }

Property Value

Type	Description
System.String

IsKnownPattern

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

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
System.Boolean

Implements

IResourceName.IsKnownPattern

LocationId

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

Declaration

public string LocationId { get; }

Property Value

Type	Description
System.String

ProjectId

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

Declaration

public string ProjectId { get; }

Property Value

Type	Description
System.String

Type

The BranchName.ResourceNameType of the contained resource name.

Declaration

public BranchName.ResourceNameType Type { get; }

Property Value

Type	Description
BranchName.ResourceNameType

UnparsedResource

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

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

Methods

Format(String, String, String, String)

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

Declaration

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

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	locationId	The Location ID. Must not be null or empty.
System.String	catalogId	The Catalog ID. Must not be null or empty.
System.String	branchId	The Branch ID. Must not be null or empty.

Returns

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

FormatProjectLocationCatalogBranch(String, String, String, String)

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

Declaration

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

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	locationId	The Location ID. Must not be null or empty.
System.String	catalogId	The Catalog ID. Must not be null or empty.
System.String	branchId	The Branch ID. Must not be null or empty.

Returns

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

FromProjectLocationCatalogBranch(String, String, String, String)

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

Declaration

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

Parameters

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

Creates a BranchName containing an unparsed resource name.

Declaration

public static BranchName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	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()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

Parse(String)

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

Declaration

public static BranchName Parse(string branchName)

Parameters

Type	Name	Description
System.String	branchName	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)

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

Declaration

public static BranchName Parse(string branchName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	branchName	The resource name in string form. Must not be null.
System.Boolean	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.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()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The string representation of the resource name.

Overrides

System.Object.ToString()

Implements

IResourceName.ToString()

TryParse(String, out BranchName)

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

Declaration

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

Parameters

Type	Name	Description
System.String	branchName	The resource name in string form. Must not be null.
BranchName	result	When this method returns, the parsed BranchName, or null if parsing failed.

Returns

Type	Description
System.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)

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

Declaration

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

Parameters

Type	Name	Description
System.String	branchName	The resource name in string form. Must not be null.
System.Boolean	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.
BranchName	result	When this method returns, the parsed BranchName, or null if parsing failed.

Returns

Type	Description
System.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)

Declaration

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

Parameters

Type	Name	Description
BranchName	a
BranchName	b

Returns

Type	Description
System.Boolean

Inequality(BranchName, BranchName)

Declaration

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

Parameters

Type	Name	Description
BranchName	a
BranchName	b

Returns

Type	Description
System.Boolean