Class MerchantCenterAccountLink (2.55.0)

public final class MerchantCenterAccountLink extends GeneratedMessageV3 implements MerchantCenterAccountLinkOrBuilder

Represents a link between a Merchant Center account and a branch. After a link is established, products from the linked Merchant Center account are streamed to the linked branch.

Protobuf type google.cloud.retail.v2alpha.MerchantCenterAccountLink

Static Fields

public static final int BRANCH_ID_FIELD_NUMBER
Field Value
Type Description
int
public static final int FEED_FILTERS_FIELD_NUMBER
Field Value
Type Description
int
public static final int FEED_LABEL_FIELD_NUMBER
Field Value
Type Description
int
public static final int ID_FIELD_NUMBER
Field Value
Type Description
int
public static final int LANGUAGE_CODE_FIELD_NUMBER
Field Value
Type Description
int
public static final int MERCHANT_CENTER_ACCOUNT_ID_FIELD_NUMBER
Field Value
Type Description
int
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int
public static final int SOURCE_FIELD_NUMBER
Field Value
Type Description
int
public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

public static MerchantCenterAccountLink getDefaultInstance()
Returns
Type Description
MerchantCenterAccountLink
public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor
public static MerchantCenterAccountLink.Builder newBuilder()
Returns
Type Description
MerchantCenterAccountLink.Builder
public static MerchantCenterAccountLink.Builder newBuilder(MerchantCenterAccountLink prototype)
Parameter
Name Description
prototype MerchantCenterAccountLink
Returns
Type Description
MerchantCenterAccountLink.Builder
public static MerchantCenterAccountLink parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MerchantCenterAccountLink
Exceptions
Type Description
IOException
public static MerchantCenterAccountLink parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MerchantCenterAccountLink
Exceptions
Type Description
IOException
public static MerchantCenterAccountLink parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
MerchantCenterAccountLink
Exceptions
Type Description
InvalidProtocolBufferException
public static MerchantCenterAccountLink parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MerchantCenterAccountLink
Exceptions
Type Description
InvalidProtocolBufferException
public static MerchantCenterAccountLink parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MerchantCenterAccountLink
Exceptions
Type Description
InvalidProtocolBufferException
public static MerchantCenterAccountLink parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MerchantCenterAccountLink
Exceptions
Type Description
InvalidProtocolBufferException
public static MerchantCenterAccountLink parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MerchantCenterAccountLink
Exceptions
Type Description
IOException
public static MerchantCenterAccountLink parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MerchantCenterAccountLink
Exceptions
Type Description
IOException
public static MerchantCenterAccountLink parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MerchantCenterAccountLink
Exceptions
Type Description
IOException
public static MerchantCenterAccountLink parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MerchantCenterAccountLink
Exceptions
Type Description
IOException
public static MerchantCenterAccountLink parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MerchantCenterAccountLink
Exceptions
Type Description
InvalidProtocolBufferException
public static MerchantCenterAccountLink parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MerchantCenterAccountLink
Exceptions
Type Description
InvalidProtocolBufferException
public static Parser<MerchantCenterAccountLink> parser()
Returns
Type Description
Parser<MerchantCenterAccountLink>

Methods

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides
public String getBranchId()

Required. The branch ID (e.g. 0/1/2) within the catalog that products from merchant_center_account_id are streamed to. When updating this field, an empty value will use the currently configured default branch. However, changing the default branch later on won't change the linked branch here.

A single branch ID can only have one linked Merchant Center account ID.

string branch_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The branchId.

public ByteString getBranchIdBytes()

Required. The branch ID (e.g. 0/1/2) within the catalog that products from merchant_center_account_id are streamed to. When updating this field, an empty value will use the currently configured default branch. However, changing the default branch later on won't change the linked branch here.

A single branch ID can only have one linked Merchant Center account ID.

string branch_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for branchId.

public MerchantCenterAccountLink getDefaultInstanceForType()
Returns
Type Description
MerchantCenterAccountLink
public MerchantCenterAccountLink.MerchantCenterFeedFilter getFeedFilters(int index)

Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds.

repeated .google.cloud.retail.v2alpha.MerchantCenterAccountLink.MerchantCenterFeedFilter feed_filters = 6;

Parameter
Name Description
index int
Returns
Type Description
MerchantCenterAccountLink.MerchantCenterFeedFilter
public int getFeedFiltersCount()

Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds.

repeated .google.cloud.retail.v2alpha.MerchantCenterAccountLink.MerchantCenterFeedFilter feed_filters = 6;

Returns
Type Description
int
public List<MerchantCenterAccountLink.MerchantCenterFeedFilter> getFeedFiltersList()

Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds.

repeated .google.cloud.retail.v2alpha.MerchantCenterAccountLink.MerchantCenterFeedFilter feed_filters = 6;

Returns
Type Description
List<MerchantCenterFeedFilter>
public MerchantCenterAccountLink.MerchantCenterFeedFilterOrBuilder getFeedFiltersOrBuilder(int index)

Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds.

repeated .google.cloud.retail.v2alpha.MerchantCenterAccountLink.MerchantCenterFeedFilter feed_filters = 6;

Parameter
Name Description
index int
Returns
Type Description
MerchantCenterAccountLink.MerchantCenterFeedFilterOrBuilder
public List<? extends MerchantCenterAccountLink.MerchantCenterFeedFilterOrBuilder> getFeedFiltersOrBuilderList()

Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds.

repeated .google.cloud.retail.v2alpha.MerchantCenterAccountLink.MerchantCenterFeedFilter feed_filters = 6;

Returns
Type Description
List<? extends com.google.cloud.retail.v2alpha.MerchantCenterAccountLink.MerchantCenterFeedFilterOrBuilder>
public String getFeedLabel()

The FeedLabel used to perform filtering. Note: this replaces region_id.

Example value: US. Example value: FeedLabel1.

string feed_label = 4;

Returns
Type Description
String

The feedLabel.

public ByteString getFeedLabelBytes()

The FeedLabel used to perform filtering. Note: this replaces region_id.

Example value: US. Example value: FeedLabel1.

string feed_label = 4;

Returns
Type Description
ByteString

The bytes for feedLabel.

public String getId()

Output only. Immutable. MerchantCenterAccountLink identifier, which is the final component of name. This field is auto generated and follows the convention: BranchId_MerchantCenterAccountId. projects/*/locations/global/catalogs/default_catalog/merchantCenterAccountLinks/id_1.

string id = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The id.

public ByteString getIdBytes()

Output only. Immutable. MerchantCenterAccountLink identifier, which is the final component of name. This field is auto generated and follows the convention: BranchId_MerchantCenterAccountId. projects/*/locations/global/catalogs/default_catalog/merchantCenterAccountLinks/id_1.

string id = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for id.

public String getLanguageCode()

Language of the title/description and other string attributes. Use language tags defined by BCP 47. ISO 639-1.

This specifies the language of offers in Merchant Center that will be accepted. If empty, no language filtering will be performed.

Example value: en.

string language_code = 5;

Returns
Type Description
String

The languageCode.

public ByteString getLanguageCodeBytes()

Language of the title/description and other string attributes. Use language tags defined by BCP 47. ISO 639-1.

This specifies the language of offers in Merchant Center that will be accepted. If empty, no language filtering will be performed.

Example value: en.

string language_code = 5;

Returns
Type Description
ByteString

The bytes for languageCode.

public long getMerchantCenterAccountId()

Required. The linked Merchant center account id. The account must be a standalone account or a sub-account of a MCA.

int64 merchant_center_account_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
long

The merchantCenterAccountId.

public String getName()

Output only. Immutable. Full resource name of the Merchant Center Account Link, such as projects/*/locations/global/catalogs/default_catalog/merchantCenterAccountLinks/merchant_center_account_link.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

public ByteString getNameBytes()

Output only. Immutable. Full resource name of the Merchant Center Account Link, such as projects/*/locations/global/catalogs/default_catalog/merchantCenterAccountLinks/merchant_center_account_link.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

public Parser<MerchantCenterAccountLink> getParserForType()
Returns
Type Description
Parser<MerchantCenterAccountLink>
Overrides
public String getProjectId()

Output only. Google Cloud project ID.

string project_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The projectId.

public ByteString getProjectIdBytes()

Output only. Google Cloud project ID.

string project_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for projectId.

public int getSerializedSize()
Returns
Type Description
int
Overrides
public String getSource()

Optional. An optional arbitrary string that could be used as a tag for tracking link source.

string source = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The source.

public ByteString getSourceBytes()

Optional. An optional arbitrary string that could be used as a tag for tracking link source.

string source = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for source.

public MerchantCenterAccountLink.State getState()

Output only. Represents the state of the link.

.google.cloud.retail.v2alpha.MerchantCenterAccountLink.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
MerchantCenterAccountLink.State

The state.

public int getStateValue()

Output only. Represents the state of the link.

.google.cloud.retail.v2alpha.MerchantCenterAccountLink.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

public int hashCode()
Returns
Type Description
int
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides
public final boolean isInitialized()
Returns
Type Description
boolean
Overrides
public MerchantCenterAccountLink.Builder newBuilderForType()
Returns
Type Description
MerchantCenterAccountLink.Builder
protected MerchantCenterAccountLink.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MerchantCenterAccountLink.Builder
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides
public MerchantCenterAccountLink.Builder toBuilder()
Returns
Type Description
MerchantCenterAccountLink.Builder
public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException