Class Subscription.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Subscription.Builder>
com.google.apps.events.subscriptions.v1beta.Subscription.Builder
- All Implemented Interfaces:
SubscriptionOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- Subscription
public static final class Subscription.Builder
extends com.google.protobuf.GeneratedMessage.Builder<Subscription.Builder>
implements SubscriptionOrBuilder
A subscription to receive events about a Google Workspace resource. To learn more about subscriptions, see the [Google Workspace Events API overview](https://developers.google.com/workspace/events).Protobuf type
google.apps.events.subscriptions.v1beta.Subscription-
Method Summary
Modifier and TypeMethodDescriptionaddAllEventTypes(Iterable<String> values) Required.addEventTypes(String value) Required.addEventTypesBytes(com.google.protobuf.ByteString value) Required.build()clear()Output only.Output only.Optional.Optional.Required.Non-empty default.Identifier.Required.Optional.Output only.Output only.Output only.Required.clearTtl()Input only.clearUid()Output only.Output only.Output only.com.google.protobuf.ByteStringOutput only.com.google.protobuf.TimestampOutput only.com.google.protobuf.Timestamp.BuilderOutput only.com.google.protobuf.TimestampOrBuilderOutput only.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorOptional.Optional.Optional.getEtag()Optional.com.google.protobuf.ByteStringOptional.getEventTypes(int index) Required.com.google.protobuf.ByteStringgetEventTypesBytes(int index) Required.intRequired.com.google.protobuf.ProtocolStringListRequired.com.google.protobuf.TimestampNon-empty default.com.google.protobuf.Timestamp.BuilderNon-empty default.com.google.protobuf.TimestampOrBuilderNon-empty default.getName()Identifier.com.google.protobuf.ByteStringIdentifier.Required.Required.Required.Optional.Optional.Optional.booleanOutput only.getState()Output only.intOutput only.Output only.intOutput only.Required.com.google.protobuf.ByteStringRequired.com.google.protobuf.DurationgetTtl()Input only.com.google.protobuf.Duration.BuilderInput only.com.google.protobuf.DurationOrBuilderInput only.getUid()Output only.com.google.protobuf.ByteStringOutput only.com.google.protobuf.TimestampOutput only.com.google.protobuf.Timestamp.BuilderOutput only.com.google.protobuf.TimestampOrBuilderOutput only.booleanOutput only.booleanOptional.booleanNon-empty default.booleanRequired.booleanOptional.booleanhasTtl()Input only.booleanOutput only.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeCreateTime(com.google.protobuf.Timestamp value) Output only.Optional.mergeExpireTime(com.google.protobuf.Timestamp value) Non-empty default.mergeFrom(Subscription other) mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) Required.Optional.mergeTtl(com.google.protobuf.Duration value) Input only.mergeUpdateTime(com.google.protobuf.Timestamp value) Output only.setAuthority(String value) Output only.setAuthorityBytes(com.google.protobuf.ByteString value) Output only.setCreateTime(com.google.protobuf.Timestamp value) Output only.setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue) Output only.Optional.setDriveOptions(Subscription.DriveOptions.Builder builderForValue) Optional.Optional.setEtagBytes(com.google.protobuf.ByteString value) Optional.setEventTypes(int index, String value) Required.setExpireTime(com.google.protobuf.Timestamp value) Non-empty default.setExpireTime(com.google.protobuf.Timestamp.Builder builderForValue) Non-empty default.Identifier.setNameBytes(com.google.protobuf.ByteString value) Identifier.Required.setNotificationEndpoint(NotificationEndpoint.Builder builderForValue) Required.setPayloadOptions(PayloadOptions value) Optional.setPayloadOptions(PayloadOptions.Builder builderForValue) Optional.setReconciling(boolean value) Output only.setState(Subscription.State value) Output only.setStateValue(int value) Output only.Output only.setSuspensionReasonValue(int value) Output only.setTargetResource(String value) Required.setTargetResourceBytes(com.google.protobuf.ByteString value) Required.setTtl(com.google.protobuf.Duration value) Input only.setTtl(com.google.protobuf.Duration.Builder builderForValue) Input only.Output only.setUidBytes(com.google.protobuf.ByteString value) Output only.setUpdateTime(com.google.protobuf.Timestamp value) Output only.setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue) Output only.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<Subscription.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<Subscription.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<Subscription.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Subscription.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<Subscription.Builder>
-
mergeFrom
public Subscription.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Subscription.Builder>- Throws:
IOException
-
getSubscriptionOptionsCase
- Specified by:
getSubscriptionOptionsCasein interfaceSubscriptionOrBuilder
-
clearSubscriptionOptions
-
getExpirationCase
- Specified by:
getExpirationCasein interfaceSubscriptionOrBuilder
-
clearExpiration
-
hasDriveOptions
public boolean hasDriveOptions()Optional. Features that are supported only for subscriptions on Drive resources.
.google.apps.events.subscriptions.v1beta.Subscription.DriveOptions drive_options = 20 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasDriveOptionsin interfaceSubscriptionOrBuilder- Returns:
- Whether the driveOptions field is set.
-
getDriveOptions
Optional. Features that are supported only for subscriptions on Drive resources.
.google.apps.events.subscriptions.v1beta.Subscription.DriveOptions drive_options = 20 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getDriveOptionsin interfaceSubscriptionOrBuilder- Returns:
- The driveOptions.
-
setDriveOptions
Optional. Features that are supported only for subscriptions on Drive resources.
.google.apps.events.subscriptions.v1beta.Subscription.DriveOptions drive_options = 20 [(.google.api.field_behavior) = OPTIONAL]; -
setDriveOptions
Optional. Features that are supported only for subscriptions on Drive resources.
.google.apps.events.subscriptions.v1beta.Subscription.DriveOptions drive_options = 20 [(.google.api.field_behavior) = OPTIONAL]; -
mergeDriveOptions
Optional. Features that are supported only for subscriptions on Drive resources.
.google.apps.events.subscriptions.v1beta.Subscription.DriveOptions drive_options = 20 [(.google.api.field_behavior) = OPTIONAL]; -
clearDriveOptions
Optional. Features that are supported only for subscriptions on Drive resources.
.google.apps.events.subscriptions.v1beta.Subscription.DriveOptions drive_options = 20 [(.google.api.field_behavior) = OPTIONAL]; -
getDriveOptionsBuilder
Optional. Features that are supported only for subscriptions on Drive resources.
.google.apps.events.subscriptions.v1beta.Subscription.DriveOptions drive_options = 20 [(.google.api.field_behavior) = OPTIONAL]; -
getDriveOptionsOrBuilder
Optional. Features that are supported only for subscriptions on Drive resources.
.google.apps.events.subscriptions.v1beta.Subscription.DriveOptions drive_options = 20 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getDriveOptionsOrBuilderin interfaceSubscriptionOrBuilder
-
hasExpireTime
public boolean hasExpireTime()Non-empty default. The timestamp in UTC when the subscription expires. Always displayed on output, regardless of what was used on input.
.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];- Specified by:
hasExpireTimein interfaceSubscriptionOrBuilder- Returns:
- Whether the expireTime field is set.
-
getExpireTime
public com.google.protobuf.Timestamp getExpireTime()Non-empty default. The timestamp in UTC when the subscription expires. Always displayed on output, regardless of what was used on input.
.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];- Specified by:
getExpireTimein interfaceSubscriptionOrBuilder- Returns:
- The expireTime.
-
setExpireTime
Non-empty default. The timestamp in UTC when the subscription expires. Always displayed on output, regardless of what was used on input.
.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT]; -
setExpireTime
Non-empty default. The timestamp in UTC when the subscription expires. Always displayed on output, regardless of what was used on input.
.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT]; -
mergeExpireTime
Non-empty default. The timestamp in UTC when the subscription expires. Always displayed on output, regardless of what was used on input.
.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT]; -
clearExpireTime
Non-empty default. The timestamp in UTC when the subscription expires. Always displayed on output, regardless of what was used on input.
.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT]; -
getExpireTimeBuilder
public com.google.protobuf.Timestamp.Builder getExpireTimeBuilder()Non-empty default. The timestamp in UTC when the subscription expires. Always displayed on output, regardless of what was used on input.
.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT]; -
getExpireTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()Non-empty default. The timestamp in UTC when the subscription expires. Always displayed on output, regardless of what was used on input.
.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];- Specified by:
getExpireTimeOrBuilderin interfaceSubscriptionOrBuilder
-
hasTtl
public boolean hasTtl()Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to `0`, uses the maximum possible duration.
.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = INPUT_ONLY];- Specified by:
hasTtlin interfaceSubscriptionOrBuilder- Returns:
- Whether the ttl field is set.
-
getTtl
public com.google.protobuf.Duration getTtl()Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to `0`, uses the maximum possible duration.
.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = INPUT_ONLY];- Specified by:
getTtlin interfaceSubscriptionOrBuilder- Returns:
- The ttl.
-
setTtl
Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to `0`, uses the maximum possible duration.
.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = INPUT_ONLY]; -
setTtl
Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to `0`, uses the maximum possible duration.
.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = INPUT_ONLY]; -
mergeTtl
Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to `0`, uses the maximum possible duration.
.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = INPUT_ONLY]; -
clearTtl
Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to `0`, uses the maximum possible duration.
.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = INPUT_ONLY]; -
getTtlBuilder
public com.google.protobuf.Duration.Builder getTtlBuilder()Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to `0`, uses the maximum possible duration.
.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = INPUT_ONLY]; -
getTtlOrBuilder
public com.google.protobuf.DurationOrBuilder getTtlOrBuilder()Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to `0`, uses the maximum possible duration.
.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = INPUT_ONLY];- Specified by:
getTtlOrBuilderin interfaceSubscriptionOrBuilder
-
getName
Identifier. Resource name of the subscription. Format: `subscriptions/{subscription}`string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Specified by:
getNamein interfaceSubscriptionOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()Identifier. Resource name of the subscription. Format: `subscriptions/{subscription}`string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Specified by:
getNameBytesin interfaceSubscriptionOrBuilder- Returns:
- The bytes for name.
-
setName
Identifier. Resource name of the subscription. Format: `subscriptions/{subscription}`string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Parameters:
value- The name to set.- Returns:
- This builder for chaining.
-
clearName
Identifier. Resource name of the subscription. Format: `subscriptions/{subscription}`string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Returns:
- This builder for chaining.
-
setNameBytes
Identifier. Resource name of the subscription. Format: `subscriptions/{subscription}`string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Parameters:
value- The bytes for name to set.- Returns:
- This builder for chaining.
-
getUid
Output only. System-assigned unique identifier for the subscription.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }- Specified by:
getUidin interfaceSubscriptionOrBuilder- Returns:
- The uid.
-
getUidBytes
public com.google.protobuf.ByteString getUidBytes()Output only. System-assigned unique identifier for the subscription.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }- Specified by:
getUidBytesin interfaceSubscriptionOrBuilder- Returns:
- The bytes for uid.
-
setUid
Output only. System-assigned unique identifier for the subscription.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }- Parameters:
value- The uid to set.- Returns:
- This builder for chaining.
-
clearUid
Output only. System-assigned unique identifier for the subscription.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }- Returns:
- This builder for chaining.
-
setUidBytes
Output only. System-assigned unique identifier for the subscription.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }- Parameters:
value- The bytes for uid to set.- Returns:
- This builder for chaining.
-
getTargetResource
Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the [full resource name](https://google.aip.dev/122#full-resource-names). To learn about target resources and the events that they support, see [Supported Google Workspace events](https://developers.google.com/workspace/events#supported-events). A user can only authorize your app to create one subscription for a given target resource. If your app tries to create another subscription with the same user credentials, the request returns an `ALREADY_EXISTS` error.
string target_resource = 4 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Specified by:
getTargetResourcein interfaceSubscriptionOrBuilder- Returns:
- The targetResource.
-
getTargetResourceBytes
public com.google.protobuf.ByteString getTargetResourceBytes()Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the [full resource name](https://google.aip.dev/122#full-resource-names). To learn about target resources and the events that they support, see [Supported Google Workspace events](https://developers.google.com/workspace/events#supported-events). A user can only authorize your app to create one subscription for a given target resource. If your app tries to create another subscription with the same user credentials, the request returns an `ALREADY_EXISTS` error.
string target_resource = 4 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Specified by:
getTargetResourceBytesin interfaceSubscriptionOrBuilder- Returns:
- The bytes for targetResource.
-
setTargetResource
Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the [full resource name](https://google.aip.dev/122#full-resource-names). To learn about target resources and the events that they support, see [Supported Google Workspace events](https://developers.google.com/workspace/events#supported-events). A user can only authorize your app to create one subscription for a given target resource. If your app tries to create another subscription with the same user credentials, the request returns an `ALREADY_EXISTS` error.
string target_resource = 4 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Parameters:
value- The targetResource to set.- Returns:
- This builder for chaining.
-
clearTargetResource
Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the [full resource name](https://google.aip.dev/122#full-resource-names). To learn about target resources and the events that they support, see [Supported Google Workspace events](https://developers.google.com/workspace/events#supported-events). A user can only authorize your app to create one subscription for a given target resource. If your app tries to create another subscription with the same user credentials, the request returns an `ALREADY_EXISTS` error.
string target_resource = 4 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Returns:
- This builder for chaining.
-
setTargetResourceBytes
Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the [full resource name](https://google.aip.dev/122#full-resource-names). To learn about target resources and the events that they support, see [Supported Google Workspace events](https://developers.google.com/workspace/events#supported-events). A user can only authorize your app to create one subscription for a given target resource. If your app tries to create another subscription with the same user credentials, the request returns an `ALREADY_EXISTS` error.
string target_resource = 4 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Parameters:
value- The bytes for targetResource to set.- Returns:
- This builder for chaining.
-
getEventTypesList
public com.google.protobuf.ProtocolStringList getEventTypesList()Required. Unordered list. Input for creating a subscription. Otherwise, output only. One or more types of events to receive about the target resource. Formatted according to the CloudEvents specification. The supported event types depend on the target resource of your subscription. For details, see [Supported Google Workspace events](https://developers.google.com/workspace/events/guides#supported-events). By default, you also receive events about the [lifecycle of your subscription](https://developers.google.com/workspace/events/guides/events-lifecycle). You don't need to specify lifecycle events for this field. If you specify an event type that doesn't exist for the target resource, the request returns an HTTP `400 Bad Request` status code.
repeated string event_types = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];- Specified by:
getEventTypesListin interfaceSubscriptionOrBuilder- Returns:
- A list containing the eventTypes.
-
getEventTypesCount
public int getEventTypesCount()Required. Unordered list. Input for creating a subscription. Otherwise, output only. One or more types of events to receive about the target resource. Formatted according to the CloudEvents specification. The supported event types depend on the target resource of your subscription. For details, see [Supported Google Workspace events](https://developers.google.com/workspace/events/guides#supported-events). By default, you also receive events about the [lifecycle of your subscription](https://developers.google.com/workspace/events/guides/events-lifecycle). You don't need to specify lifecycle events for this field. If you specify an event type that doesn't exist for the target resource, the request returns an HTTP `400 Bad Request` status code.
repeated string event_types = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];- Specified by:
getEventTypesCountin interfaceSubscriptionOrBuilder- Returns:
- The count of eventTypes.
-
getEventTypes
Required. Unordered list. Input for creating a subscription. Otherwise, output only. One or more types of events to receive about the target resource. Formatted according to the CloudEvents specification. The supported event types depend on the target resource of your subscription. For details, see [Supported Google Workspace events](https://developers.google.com/workspace/events/guides#supported-events). By default, you also receive events about the [lifecycle of your subscription](https://developers.google.com/workspace/events/guides/events-lifecycle). You don't need to specify lifecycle events for this field. If you specify an event type that doesn't exist for the target resource, the request returns an HTTP `400 Bad Request` status code.
repeated string event_types = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];- Specified by:
getEventTypesin interfaceSubscriptionOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The eventTypes at the given index.
-
getEventTypesBytes
public com.google.protobuf.ByteString getEventTypesBytes(int index) Required. Unordered list. Input for creating a subscription. Otherwise, output only. One or more types of events to receive about the target resource. Formatted according to the CloudEvents specification. The supported event types depend on the target resource of your subscription. For details, see [Supported Google Workspace events](https://developers.google.com/workspace/events/guides#supported-events). By default, you also receive events about the [lifecycle of your subscription](https://developers.google.com/workspace/events/guides/events-lifecycle). You don't need to specify lifecycle events for this field. If you specify an event type that doesn't exist for the target resource, the request returns an HTTP `400 Bad Request` status code.
repeated string event_types = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];- Specified by:
getEventTypesBytesin interfaceSubscriptionOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the eventTypes at the given index.
-
setEventTypes
Required. Unordered list. Input for creating a subscription. Otherwise, output only. One or more types of events to receive about the target resource. Formatted according to the CloudEvents specification. The supported event types depend on the target resource of your subscription. For details, see [Supported Google Workspace events](https://developers.google.com/workspace/events/guides#supported-events). By default, you also receive events about the [lifecycle of your subscription](https://developers.google.com/workspace/events/guides/events-lifecycle). You don't need to specify lifecycle events for this field. If you specify an event type that doesn't exist for the target resource, the request returns an HTTP `400 Bad Request` status code.
repeated string event_types = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];- Parameters:
index- The index to set the value at.value- The eventTypes to set.- Returns:
- This builder for chaining.
-
addEventTypes
Required. Unordered list. Input for creating a subscription. Otherwise, output only. One or more types of events to receive about the target resource. Formatted according to the CloudEvents specification. The supported event types depend on the target resource of your subscription. For details, see [Supported Google Workspace events](https://developers.google.com/workspace/events/guides#supported-events). By default, you also receive events about the [lifecycle of your subscription](https://developers.google.com/workspace/events/guides/events-lifecycle). You don't need to specify lifecycle events for this field. If you specify an event type that doesn't exist for the target resource, the request returns an HTTP `400 Bad Request` status code.
repeated string event_types = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];- Parameters:
value- The eventTypes to add.- Returns:
- This builder for chaining.
-
addAllEventTypes
Required. Unordered list. Input for creating a subscription. Otherwise, output only. One or more types of events to receive about the target resource. Formatted according to the CloudEvents specification. The supported event types depend on the target resource of your subscription. For details, see [Supported Google Workspace events](https://developers.google.com/workspace/events/guides#supported-events). By default, you also receive events about the [lifecycle of your subscription](https://developers.google.com/workspace/events/guides/events-lifecycle). You don't need to specify lifecycle events for this field. If you specify an event type that doesn't exist for the target resource, the request returns an HTTP `400 Bad Request` status code.
repeated string event_types = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];- Parameters:
values- The eventTypes to add.- Returns:
- This builder for chaining.
-
clearEventTypes
Required. Unordered list. Input for creating a subscription. Otherwise, output only. One or more types of events to receive about the target resource. Formatted according to the CloudEvents specification. The supported event types depend on the target resource of your subscription. For details, see [Supported Google Workspace events](https://developers.google.com/workspace/events/guides#supported-events). By default, you also receive events about the [lifecycle of your subscription](https://developers.google.com/workspace/events/guides/events-lifecycle). You don't need to specify lifecycle events for this field. If you specify an event type that doesn't exist for the target resource, the request returns an HTTP `400 Bad Request` status code.
repeated string event_types = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];- Returns:
- This builder for chaining.
-
addEventTypesBytes
Required. Unordered list. Input for creating a subscription. Otherwise, output only. One or more types of events to receive about the target resource. Formatted according to the CloudEvents specification. The supported event types depend on the target resource of your subscription. For details, see [Supported Google Workspace events](https://developers.google.com/workspace/events/guides#supported-events). By default, you also receive events about the [lifecycle of your subscription](https://developers.google.com/workspace/events/guides/events-lifecycle). You don't need to specify lifecycle events for this field. If you specify an event type that doesn't exist for the target resource, the request returns an HTTP `400 Bad Request` status code.
repeated string event_types = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];- Parameters:
value- The bytes of the eventTypes to add.- Returns:
- This builder for chaining.
-
hasPayloadOptions
public boolean hasPayloadOptions()Optional. Options about what data to include in the event payload. Only supported for Google Chat events.
.google.apps.events.subscriptions.v1beta.PayloadOptions payload_options = 6 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasPayloadOptionsin interfaceSubscriptionOrBuilder- Returns:
- Whether the payloadOptions field is set.
-
getPayloadOptions
Optional. Options about what data to include in the event payload. Only supported for Google Chat events.
.google.apps.events.subscriptions.v1beta.PayloadOptions payload_options = 6 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getPayloadOptionsin interfaceSubscriptionOrBuilder- Returns:
- The payloadOptions.
-
setPayloadOptions
Optional. Options about what data to include in the event payload. Only supported for Google Chat events.
.google.apps.events.subscriptions.v1beta.PayloadOptions payload_options = 6 [(.google.api.field_behavior) = OPTIONAL]; -
setPayloadOptions
Optional. Options about what data to include in the event payload. Only supported for Google Chat events.
.google.apps.events.subscriptions.v1beta.PayloadOptions payload_options = 6 [(.google.api.field_behavior) = OPTIONAL]; -
mergePayloadOptions
Optional. Options about what data to include in the event payload. Only supported for Google Chat events.
.google.apps.events.subscriptions.v1beta.PayloadOptions payload_options = 6 [(.google.api.field_behavior) = OPTIONAL]; -
clearPayloadOptions
Optional. Options about what data to include in the event payload. Only supported for Google Chat events.
.google.apps.events.subscriptions.v1beta.PayloadOptions payload_options = 6 [(.google.api.field_behavior) = OPTIONAL]; -
getPayloadOptionsBuilder
Optional. Options about what data to include in the event payload. Only supported for Google Chat events.
.google.apps.events.subscriptions.v1beta.PayloadOptions payload_options = 6 [(.google.api.field_behavior) = OPTIONAL]; -
getPayloadOptionsOrBuilder
Optional. Options about what data to include in the event payload. Only supported for Google Chat events.
.google.apps.events.subscriptions.v1beta.PayloadOptions payload_options = 6 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getPayloadOptionsOrBuilderin interfaceSubscriptionOrBuilder
-
hasNotificationEndpoint
public boolean hasNotificationEndpoint()Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic.
.google.apps.events.subscriptions.v1beta.NotificationEndpoint notification_endpoint = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];- Specified by:
hasNotificationEndpointin interfaceSubscriptionOrBuilder- Returns:
- Whether the notificationEndpoint field is set.
-
getNotificationEndpoint
Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic.
.google.apps.events.subscriptions.v1beta.NotificationEndpoint notification_endpoint = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];- Specified by:
getNotificationEndpointin interfaceSubscriptionOrBuilder- Returns:
- The notificationEndpoint.
-
setNotificationEndpoint
Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic.
.google.apps.events.subscriptions.v1beta.NotificationEndpoint notification_endpoint = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE]; -
setNotificationEndpoint
Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic.
.google.apps.events.subscriptions.v1beta.NotificationEndpoint notification_endpoint = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE]; -
mergeNotificationEndpoint
Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic.
.google.apps.events.subscriptions.v1beta.NotificationEndpoint notification_endpoint = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE]; -
clearNotificationEndpoint
Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic.
.google.apps.events.subscriptions.v1beta.NotificationEndpoint notification_endpoint = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE]; -
getNotificationEndpointBuilder
Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic.
.google.apps.events.subscriptions.v1beta.NotificationEndpoint notification_endpoint = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE]; -
getNotificationEndpointOrBuilder
Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic.
.google.apps.events.subscriptions.v1beta.NotificationEndpoint notification_endpoint = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];- Specified by:
getNotificationEndpointOrBuilderin interfaceSubscriptionOrBuilder
-
getStateValue
public int getStateValue()Output only. The state of the subscription. Determines whether the subscription can receive events and deliver them to the notification endpoint.
.google.apps.events.subscriptions.v1beta.Subscription.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStateValuein interfaceSubscriptionOrBuilder- Returns:
- The enum numeric value on the wire for state.
-
setStateValue
Output only. The state of the subscription. Determines whether the subscription can receive events and deliver them to the notification endpoint.
.google.apps.events.subscriptions.v1beta.Subscription.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The enum numeric value on the wire for state to set.- Returns:
- This builder for chaining.
-
getState
Output only. The state of the subscription. Determines whether the subscription can receive events and deliver them to the notification endpoint.
.google.apps.events.subscriptions.v1beta.Subscription.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStatein interfaceSubscriptionOrBuilder- Returns:
- The state.
-
setState
Output only. The state of the subscription. Determines whether the subscription can receive events and deliver them to the notification endpoint.
.google.apps.events.subscriptions.v1beta.Subscription.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The state to set.- Returns:
- This builder for chaining.
-
clearState
Output only. The state of the subscription. Determines whether the subscription can receive events and deliver them to the notification endpoint.
.google.apps.events.subscriptions.v1beta.Subscription.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
getSuspensionReasonValue
public int getSuspensionReasonValue()Output only. The error that suspended the subscription. To reactivate the subscription, resolve the error and call the [`ReactivateSubscription`][google.apps.events.subscriptions.v1beta.SubscriptionsService.ReactivateSubscription] method.
.google.apps.events.subscriptions.v1beta.Subscription.ErrorType suspension_reason = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSuspensionReasonValuein interfaceSubscriptionOrBuilder- Returns:
- The enum numeric value on the wire for suspensionReason.
-
setSuspensionReasonValue
Output only. The error that suspended the subscription. To reactivate the subscription, resolve the error and call the [`ReactivateSubscription`][google.apps.events.subscriptions.v1beta.SubscriptionsService.ReactivateSubscription] method.
.google.apps.events.subscriptions.v1beta.Subscription.ErrorType suspension_reason = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The enum numeric value on the wire for suspensionReason to set.- Returns:
- This builder for chaining.
-
getSuspensionReason
Output only. The error that suspended the subscription. To reactivate the subscription, resolve the error and call the [`ReactivateSubscription`][google.apps.events.subscriptions.v1beta.SubscriptionsService.ReactivateSubscription] method.
.google.apps.events.subscriptions.v1beta.Subscription.ErrorType suspension_reason = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSuspensionReasonin interfaceSubscriptionOrBuilder- Returns:
- The suspensionReason.
-
setSuspensionReason
Output only. The error that suspended the subscription. To reactivate the subscription, resolve the error and call the [`ReactivateSubscription`][google.apps.events.subscriptions.v1beta.SubscriptionsService.ReactivateSubscription] method.
.google.apps.events.subscriptions.v1beta.Subscription.ErrorType suspension_reason = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The suspensionReason to set.- Returns:
- This builder for chaining.
-
clearSuspensionReason
Output only. The error that suspended the subscription. To reactivate the subscription, resolve the error and call the [`ReactivateSubscription`][google.apps.events.subscriptions.v1beta.SubscriptionsService.ReactivateSubscription] method.
.google.apps.events.subscriptions.v1beta.Subscription.ErrorType suspension_reason = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
getAuthority
Output only. The user who authorized the creation of the subscription. Format: `users/{user}` For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API.string authority = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getAuthorityin interfaceSubscriptionOrBuilder- Returns:
- The authority.
-
getAuthorityBytes
public com.google.protobuf.ByteString getAuthorityBytes()Output only. The user who authorized the creation of the subscription. Format: `users/{user}` For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API.string authority = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getAuthorityBytesin interfaceSubscriptionOrBuilder- Returns:
- The bytes for authority.
-
setAuthority
Output only. The user who authorized the creation of the subscription. Format: `users/{user}` For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API.string authority = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Parameters:
value- The authority to set.- Returns:
- This builder for chaining.
-
clearAuthority
Output only. The user who authorized the creation of the subscription. Format: `users/{user}` For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API.string authority = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Returns:
- This builder for chaining.
-
setAuthorityBytes
Output only. The user who authorized the creation of the subscription. Format: `users/{user}` For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API.string authority = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Parameters:
value- The bytes for authority to set.- Returns:
- This builder for chaining.
-
hasCreateTime
public boolean hasCreateTime()Output only. The time when the subscription is created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasCreateTimein interfaceSubscriptionOrBuilder- Returns:
- Whether the createTime field is set.
-
getCreateTime
public com.google.protobuf.Timestamp getCreateTime()Output only. The time when the subscription is created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimein interfaceSubscriptionOrBuilder- Returns:
- The createTime.
-
setCreateTime
Output only. The time when the subscription is created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
setCreateTime
Output only. The time when the subscription is created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
mergeCreateTime
Output only. The time when the subscription is created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
clearCreateTime
Output only. The time when the subscription is created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getCreateTimeBuilder
public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()Output only. The time when the subscription is created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getCreateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. The time when the subscription is created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimeOrBuilderin interfaceSubscriptionOrBuilder
-
hasUpdateTime
public boolean hasUpdateTime()Output only. The last time that the subscription is updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasUpdateTimein interfaceSubscriptionOrBuilder- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
public com.google.protobuf.Timestamp getUpdateTime()Output only. The last time that the subscription is updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimein interfaceSubscriptionOrBuilder- Returns:
- The updateTime.
-
setUpdateTime
Output only. The last time that the subscription is updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
setUpdateTime
Output only. The last time that the subscription is updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
mergeUpdateTime
Output only. The last time that the subscription is updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
clearUpdateTime
Output only. The last time that the subscription is updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getUpdateTimeBuilder
public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()Output only. The last time that the subscription is updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getUpdateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The last time that the subscription is updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimeOrBuilderin interfaceSubscriptionOrBuilder
-
getReconciling
public boolean getReconciling()Output only. If `true`, the subscription is in the process of being updated.
bool reconciling = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getReconcilingin interfaceSubscriptionOrBuilder- Returns:
- The reconciling.
-
setReconciling
Output only. If `true`, the subscription is in the process of being updated.
bool reconciling = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The reconciling to set.- Returns:
- This builder for chaining.
-
clearReconciling
Output only. If `true`, the subscription is in the process of being updated.
bool reconciling = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
getEtag
Optional. This checksum is computed by the server based on the value of other fields, and might be sent on update requests to ensure the client has an up-to-date value before proceeding.
string etag = 17 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getEtagin interfaceSubscriptionOrBuilder- Returns:
- The etag.
-
getEtagBytes
public com.google.protobuf.ByteString getEtagBytes()Optional. This checksum is computed by the server based on the value of other fields, and might be sent on update requests to ensure the client has an up-to-date value before proceeding.
string etag = 17 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getEtagBytesin interfaceSubscriptionOrBuilder- Returns:
- The bytes for etag.
-
setEtag
Optional. This checksum is computed by the server based on the value of other fields, and might be sent on update requests to ensure the client has an up-to-date value before proceeding.
string etag = 17 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The etag to set.- Returns:
- This builder for chaining.
-
clearEtag
Optional. This checksum is computed by the server based on the value of other fields, and might be sent on update requests to ensure the client has an up-to-date value before proceeding.
string etag = 17 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- This builder for chaining.
-
setEtagBytes
Optional. This checksum is computed by the server based on the value of other fields, and might be sent on update requests to ensure the client has an up-to-date value before proceeding.
string etag = 17 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The bytes for etag to set.- Returns:
- This builder for chaining.
-