Interface GetBranchRequestOrBuilder (2.56.0)

public interface GetBranchRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getName()

public abstract String getName()

Required. The name of the branch to retrieve. Format: projects/*/locations/global/catalogs/default_catalog/branches/some_branch_id.

"default_branch" can be used as a special branch_id, it returns the default branch that has been set for the catalog.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. The name of the branch to retrieve. Format: projects/*/locations/global/catalogs/default_catalog/branches/some_branch_id.

"default_branch" can be used as a special branch_id, it returns the default branch that has been set for the catalog.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getView()

public abstract BranchView getView()

The view to apply to the returned Branch. Defaults to [Branch.BranchView.BASIC] if unspecified. See documentation of fields of Branch to find what fields are excluded from BASIC view.

.google.cloud.retail.v2alpha.BranchView view = 2;

Returns
Type Description
BranchView

The view.

getViewValue()

public abstract int getViewValue()

The view to apply to the returned Branch. Defaults to [Branch.BranchView.BASIC] if unspecified. See documentation of fields of Branch to find what fields are excluded from BASIC view.

.google.cloud.retail.v2alpha.BranchView view = 2;

Returns
Type Description
int

The enum numeric value on the wire for view.