Retail v2 API - Class BranchName (2.11.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

Implements

IResourceName, IEquatable BranchName

Inherited Members

object.GetType()

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

Type

public BranchName.ResourceNameType Type { get; }

The BranchName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`BranchNameResourceNameType`

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

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, 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
Name	Description
`branchName`	`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
`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
`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
Name	Description
`branchName`	`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`	`BranchName` When this method returns, the parsed BranchName, 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}/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)

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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