Class NotificationSubscription.Builder (1.13.0)

public static final class NotificationSubscription.Builder extends GeneratedMessage.Builder<NotificationSubscription.Builder> implements NotificationSubscriptionOrBuilder

Represents a notification subscription owned by a Merchant account.

Protobuf type google.shopping.merchant.notifications.v1beta.NotificationSubscription

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public NotificationSubscription build()
Returns
Type Description
NotificationSubscription

buildPartial()

public NotificationSubscription buildPartial()
Returns
Type Description
NotificationSubscription

clear()

public NotificationSubscription.Builder clear()
Returns
Type Description
NotificationSubscription.Builder
Overrides

clearAllManagedAccounts()

public NotificationSubscription.Builder clearAllManagedAccounts()

If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis.

bool all_managed_accounts = 3;

Returns
Type Description
NotificationSubscription.Builder

This builder for chaining.

clearCallBackUri()

public NotificationSubscription.Builder clearCallBackUri()

URL to be used to push the notification to the merchant.

string call_back_uri = 5;

Returns
Type Description
NotificationSubscription.Builder

This builder for chaining.

clearInterestedIn()

public NotificationSubscription.Builder clearInterestedIn()
Returns
Type Description
NotificationSubscription.Builder

clearName()

public NotificationSubscription.Builder clearName()

Output only. The name of the notification configuration. Generated by the Content API upon creation of a new NotificationSubscription. The account represents the merchant ID of the merchant that owns the configuration. Format: accounts/{account}/notificationsubscriptions/{notification_subscription}

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

Returns
Type Description
NotificationSubscription.Builder

This builder for chaining.

clearRegisteredEvent()

public NotificationSubscription.Builder clearRegisteredEvent()

The event that the merchant wants to be notified about.

.google.shopping.merchant.notifications.v1beta.NotificationSubscription.NotificationEventType registered_event = 2;

Returns
Type Description
NotificationSubscription.Builder

This builder for chaining.

clearTargetAccount()

public NotificationSubscription.Builder clearTargetAccount()

The name of the account you want to receive notifications for. Format: accounts/{account}

string target_account = 4;

Returns
Type Description
NotificationSubscription.Builder

This builder for chaining.

getAllManagedAccounts()

public boolean getAllManagedAccounts()

If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis.

bool all_managed_accounts = 3;

Returns
Type Description
boolean

The allManagedAccounts.

getCallBackUri()

public String getCallBackUri()

URL to be used to push the notification to the merchant.

string call_back_uri = 5;

Returns
Type Description
String

The callBackUri.

getCallBackUriBytes()

public ByteString getCallBackUriBytes()

URL to be used to push the notification to the merchant.

string call_back_uri = 5;

Returns
Type Description
ByteString

The bytes for callBackUri.

getDefaultInstanceForType()

public NotificationSubscription getDefaultInstanceForType()
Returns
Type Description
NotificationSubscription

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getInterestedInCase()

public NotificationSubscription.InterestedInCase getInterestedInCase()
Returns
Type Description
NotificationSubscription.InterestedInCase

getName()

public String getName()

Output only. The name of the notification configuration. Generated by the Content API upon creation of a new NotificationSubscription. The account represents the merchant ID of the merchant that owns the configuration. Format: accounts/{account}/notificationsubscriptions/{notification_subscription}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The name of the notification configuration. Generated by the Content API upon creation of a new NotificationSubscription. The account represents the merchant ID of the merchant that owns the configuration. Format: accounts/{account}/notificationsubscriptions/{notification_subscription}

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

Returns
Type Description
ByteString

The bytes for name.

getRegisteredEvent()

public NotificationSubscription.NotificationEventType getRegisteredEvent()

The event that the merchant wants to be notified about.

.google.shopping.merchant.notifications.v1beta.NotificationSubscription.NotificationEventType registered_event = 2;

Returns
Type Description
NotificationSubscription.NotificationEventType

The registeredEvent.

getRegisteredEventValue()

public int getRegisteredEventValue()

The event that the merchant wants to be notified about.

.google.shopping.merchant.notifications.v1beta.NotificationSubscription.NotificationEventType registered_event = 2;

Returns
Type Description
int

The enum numeric value on the wire for registeredEvent.

getTargetAccount()

public String getTargetAccount()

The name of the account you want to receive notifications for. Format: accounts/{account}

string target_account = 4;

Returns
Type Description
String

The targetAccount.

getTargetAccountBytes()

public ByteString getTargetAccountBytes()

The name of the account you want to receive notifications for. Format: accounts/{account}

string target_account = 4;

Returns
Type Description
ByteString

The bytes for targetAccount.

hasAllManagedAccounts()

public boolean hasAllManagedAccounts()

If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis.

bool all_managed_accounts = 3;

Returns
Type Description
boolean

Whether the allManagedAccounts field is set.

hasTargetAccount()

public boolean hasTargetAccount()

The name of the account you want to receive notifications for. Format: accounts/{account}

string target_account = 4;

Returns
Type Description
boolean

Whether the targetAccount field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public NotificationSubscription.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NotificationSubscription.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public NotificationSubscription.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
NotificationSubscription.Builder
Overrides

mergeFrom(NotificationSubscription other)

public NotificationSubscription.Builder mergeFrom(NotificationSubscription other)
Parameter
Name Description
other NotificationSubscription
Returns
Type Description
NotificationSubscription.Builder

setAllManagedAccounts(boolean value)

public NotificationSubscription.Builder setAllManagedAccounts(boolean value)

If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis.

bool all_managed_accounts = 3;

Parameter
Name Description
value boolean

The allManagedAccounts to set.

Returns
Type Description
NotificationSubscription.Builder

This builder for chaining.

setCallBackUri(String value)

public NotificationSubscription.Builder setCallBackUri(String value)

URL to be used to push the notification to the merchant.

string call_back_uri = 5;

Parameter
Name Description
value String

The callBackUri to set.

Returns
Type Description
NotificationSubscription.Builder

This builder for chaining.

setCallBackUriBytes(ByteString value)

public NotificationSubscription.Builder setCallBackUriBytes(ByteString value)

URL to be used to push the notification to the merchant.

string call_back_uri = 5;

Parameter
Name Description
value ByteString

The bytes for callBackUri to set.

Returns
Type Description
NotificationSubscription.Builder

This builder for chaining.

setName(String value)

public NotificationSubscription.Builder setName(String value)

Output only. The name of the notification configuration. Generated by the Content API upon creation of a new NotificationSubscription. The account represents the merchant ID of the merchant that owns the configuration. Format: accounts/{account}/notificationsubscriptions/{notification_subscription}

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
NotificationSubscription.Builder

This builder for chaining.

setNameBytes(ByteString value)

public NotificationSubscription.Builder setNameBytes(ByteString value)

Output only. The name of the notification configuration. Generated by the Content API upon creation of a new NotificationSubscription. The account represents the merchant ID of the merchant that owns the configuration. Format: accounts/{account}/notificationsubscriptions/{notification_subscription}

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
NotificationSubscription.Builder

This builder for chaining.

setRegisteredEvent(NotificationSubscription.NotificationEventType value)

public NotificationSubscription.Builder setRegisteredEvent(NotificationSubscription.NotificationEventType value)

The event that the merchant wants to be notified about.

.google.shopping.merchant.notifications.v1beta.NotificationSubscription.NotificationEventType registered_event = 2;

Parameter
Name Description
value NotificationSubscription.NotificationEventType

The registeredEvent to set.

Returns
Type Description
NotificationSubscription.Builder

This builder for chaining.

setRegisteredEventValue(int value)

public NotificationSubscription.Builder setRegisteredEventValue(int value)

The event that the merchant wants to be notified about.

.google.shopping.merchant.notifications.v1beta.NotificationSubscription.NotificationEventType registered_event = 2;

Parameter
Name Description
value int

The enum numeric value on the wire for registeredEvent to set.

Returns
Type Description
NotificationSubscription.Builder

This builder for chaining.

setTargetAccount(String value)

public NotificationSubscription.Builder setTargetAccount(String value)

The name of the account you want to receive notifications for. Format: accounts/{account}

string target_account = 4;

Parameter
Name Description
value String

The targetAccount to set.

Returns
Type Description
NotificationSubscription.Builder

This builder for chaining.

setTargetAccountBytes(ByteString value)

public NotificationSubscription.Builder setTargetAccountBytes(ByteString value)

The name of the account you want to receive notifications for. Format: accounts/{account}

string target_account = 4;

Parameter
Name Description
value ByteString

The bytes for targetAccount to set.

Returns
Type Description
NotificationSubscription.Builder

This builder for chaining.