public static final class Subscription.Builder extends GeneratedMessageV3.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.
Protobuf type google.apps.events.subscriptions.v1.Subscription
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Subscription.BuilderImplements
SubscriptionOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllEventTypes(Iterable<String> values)
public Subscription.Builder addAllEventTypes(Iterable<String> values)
Required. Immutable. 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.
By default, you also receive events about the lifecycle of your subscription. 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, (.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
values | Iterable<String> The eventTypes to add. |
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
addEventTypes(String value)
public Subscription.Builder addEventTypes(String value)
Required. Immutable. 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.
By default, you also receive events about the lifecycle of your subscription. 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, (.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
value | String The eventTypes to add. |
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
addEventTypesBytes(ByteString value)
public Subscription.Builder addEventTypesBytes(ByteString value)
Required. Immutable. 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.
By default, you also receive events about the lifecycle of your subscription. 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, (.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes of the eventTypes to add. |
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Subscription.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
build()
public Subscription build()
Returns | |
---|---|
Type | Description |
Subscription |
buildPartial()
public Subscription buildPartial()
Returns | |
---|---|
Type | Description |
Subscription |
clear()
public Subscription.Builder clear()
Returns | |
---|---|
Type | Description |
Subscription.Builder |
clearAuthority()
public Subscription.Builder 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
field from the Directory API.
string authority = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
clearCreateTime()
public Subscription.Builder clearCreateTime()
Output only. The time when the subscription is created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Subscription.Builder |
clearEtag()
public Subscription.Builder 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 | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
clearEventTypes()
public Subscription.Builder clearEventTypes()
Required. Immutable. 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.
By default, you also receive events about the lifecycle of your subscription. 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, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
clearExpiration()
public Subscription.Builder clearExpiration()
Returns | |
---|---|
Type | Description |
Subscription.Builder |
clearExpireTime()
public Subscription.Builder 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];
Returns | |
---|---|
Type | Description |
Subscription.Builder |
clearField(Descriptors.FieldDescriptor field)
public Subscription.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
clearName()
public Subscription.Builder clearName()
Optional. Immutable. Identifier. Resource name of the subscription.
Format: subscriptions/{subscription}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
clearNotificationEndpoint()
public Subscription.Builder clearNotificationEndpoint()
Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic.
.google.apps.events.subscriptions.v1.NotificationEndpoint notification_endpoint = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
Subscription.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public Subscription.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
clearPayloadOptions()
public Subscription.Builder clearPayloadOptions()
Optional. Options about what data to include in the event payload. Only supported for Google Chat events.
.google.apps.events.subscriptions.v1.PayloadOptions payload_options = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Subscription.Builder |
clearReconciling()
public Subscription.Builder clearReconciling()
Output only. If true
, the subscription is in the process of being
updated.
bool reconciling = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
clearState()
public Subscription.Builder 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.v1.Subscription.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
clearSuspensionReason()
public Subscription.Builder clearSuspensionReason()
Output only. The error that suspended the subscription.
To reactivate the subscription, resolve the error and call the
ReactivateSubscription
method.
.google.apps.events.subscriptions.v1.Subscription.ErrorType suspension_reason = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
clearTargetResource()
public Subscription.Builder clearTargetResource()
Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the full resource name. To learn about target resources and the events that they support, see Supported Google Workspace 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 | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
clearTtl()
public Subscription.Builder 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];
Returns | |
---|---|
Type | Description |
Subscription.Builder |
clearUid()
public Subscription.Builder clearUid()
Output only. System-assigned unique identifier for the subscription.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
clearUpdateTime()
public Subscription.Builder clearUpdateTime()
Output only. The last time that the subscription is updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Subscription.Builder |
clone()
public Subscription.Builder clone()
Returns | |
---|---|
Type | Description |
Subscription.Builder |
getAuthority()
public String 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
field from the Directory API.
string authority = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String | The authority. |
getAuthorityBytes()
public 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
field from the Directory API.
string authority = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString | The bytes for authority. |
getCreateTime()
public Timestamp getCreateTime()
Output only. The time when the subscription is created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp | The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()
Output only. The time when the subscription is created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time when the subscription is created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getDefaultInstanceForType()
public Subscription getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Subscription |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getEtag()
public String 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];
Returns | |
---|---|
Type | Description |
String | The etag. |
getEtagBytes()
public 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];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for etag. |
getEventTypes(int index)
public String getEventTypes(int index)
Required. Immutable. 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.
By default, you also receive events about the lifecycle of your subscription. 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, (.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
index | int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String | The eventTypes at the given index. |
getEventTypesBytes(int index)
public ByteString getEventTypesBytes(int index)
Required. Immutable. 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.
By default, you also receive events about the lifecycle of your subscription. 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, (.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
index | int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString | The bytes of the eventTypes at the given index. |
getEventTypesCount()
public int getEventTypesCount()
Required. Immutable. 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.
By default, you also receive events about the lifecycle of your subscription. 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, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
int | The count of eventTypes. |
getEventTypesList()
public ProtocolStringList getEventTypesList()
Required. Immutable. 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.
By default, you also receive events about the lifecycle of your subscription. 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, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
ProtocolStringList | A list containing the eventTypes. |
getExpirationCase()
public Subscription.ExpirationCase getExpirationCase()
Returns | |
---|---|
Type | Description |
Subscription.ExpirationCase |
getExpireTime()
public 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];
Returns | |
---|---|
Type | Description |
Timestamp | The expireTime. |
getExpireTimeBuilder()
public 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];
Returns | |
---|---|
Type | Description |
Builder |
getExpireTimeOrBuilder()
public 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];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getName()
public String getName()
Optional. Immutable. Identifier. Resource name of the subscription.
Format: subscriptions/{subscription}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes()
Optional. Immutable. Identifier. Resource name of the subscription.
Format: subscriptions/{subscription}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for name. |
getNotificationEndpoint()
public NotificationEndpoint getNotificationEndpoint()
Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic.
.google.apps.events.subscriptions.v1.NotificationEndpoint notification_endpoint = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
NotificationEndpoint | The notificationEndpoint. |
getNotificationEndpointBuilder()
public NotificationEndpoint.Builder getNotificationEndpointBuilder()
Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic.
.google.apps.events.subscriptions.v1.NotificationEndpoint notification_endpoint = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
NotificationEndpoint.Builder |
getNotificationEndpointOrBuilder()
public NotificationEndpointOrBuilder getNotificationEndpointOrBuilder()
Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic.
.google.apps.events.subscriptions.v1.NotificationEndpoint notification_endpoint = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
NotificationEndpointOrBuilder |
getPayloadOptions()
public PayloadOptions getPayloadOptions()
Optional. Options about what data to include in the event payload. Only supported for Google Chat events.
.google.apps.events.subscriptions.v1.PayloadOptions payload_options = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
PayloadOptions | The payloadOptions. |
getPayloadOptionsBuilder()
public PayloadOptions.Builder getPayloadOptionsBuilder()
Optional. Options about what data to include in the event payload. Only supported for Google Chat events.
.google.apps.events.subscriptions.v1.PayloadOptions payload_options = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
PayloadOptions.Builder |
getPayloadOptionsOrBuilder()
public PayloadOptionsOrBuilder getPayloadOptionsOrBuilder()
Optional. Options about what data to include in the event payload. Only supported for Google Chat events.
.google.apps.events.subscriptions.v1.PayloadOptions payload_options = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
PayloadOptionsOrBuilder |
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];
Returns | |
---|---|
Type | Description |
boolean | The reconciling. |
getState()
public Subscription.State 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.v1.Subscription.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Subscription.State | The state. |
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.v1.Subscription.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire for state. |
getSuspensionReason()
public Subscription.ErrorType getSuspensionReason()
Output only. The error that suspended the subscription.
To reactivate the subscription, resolve the error and call the
ReactivateSubscription
method.
.google.apps.events.subscriptions.v1.Subscription.ErrorType suspension_reason = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Subscription.ErrorType | The suspensionReason. |
getSuspensionReasonValue()
public int getSuspensionReasonValue()
Output only. The error that suspended the subscription.
To reactivate the subscription, resolve the error and call the
ReactivateSubscription
method.
.google.apps.events.subscriptions.v1.Subscription.ErrorType suspension_reason = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire for suspensionReason. |
getTargetResource()
public String getTargetResource()
Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the full resource name. To learn about target resources and the events that they support, see Supported Google Workspace 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 | |
---|---|
Type | Description |
String | The targetResource. |
getTargetResourceBytes()
public ByteString getTargetResourceBytes()
Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the full resource name. To learn about target resources and the events that they support, see Supported Google Workspace 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 | |
---|---|
Type | Description |
ByteString | The bytes for targetResource. |
getTtl()
public 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];
Returns | |
---|---|
Type | Description |
Duration | The ttl. |
getTtlBuilder()
public 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];
Returns | |
---|---|
Type | Description |
Builder |
getTtlOrBuilder()
public 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];
Returns | |
---|---|
Type | Description |
DurationOrBuilder |
getUid()
public String getUid()
Output only. System-assigned unique identifier for the subscription.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String | The uid. |
getUidBytes()
public ByteString getUidBytes()
Output only. System-assigned unique identifier for the subscription.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for uid. |
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The last time that the subscription is updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp | The updateTime. |
getUpdateTimeBuilder()
public 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];
Returns | |
---|---|
Type | Description |
Builder |
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The last time that the subscription is updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
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];
Returns | |
---|---|
Type | Description |
boolean | Whether the createTime field is set. |
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];
Returns | |
---|---|
Type | Description |
boolean | Whether the expireTime field is set. |
hasNotificationEndpoint()
public boolean hasNotificationEndpoint()
Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic.
.google.apps.events.subscriptions.v1.NotificationEndpoint notification_endpoint = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
boolean | Whether the notificationEndpoint field is set. |
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.v1.PayloadOptions payload_options = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean | Whether the payloadOptions field is set. |
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];
Returns | |
---|---|
Type | Description |
boolean | Whether the ttl field is set. |
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];
Returns | |
---|---|
Type | Description |
boolean | Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeCreateTime(Timestamp value)
public Subscription.Builder mergeCreateTime(Timestamp value)
Output only. The time when the subscription is created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
mergeExpireTime(Timestamp value)
public Subscription.Builder mergeExpireTime(Timestamp value)
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];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
mergeFrom(Subscription other)
public Subscription.Builder mergeFrom(Subscription other)
Parameter | |
---|---|
Name | Description |
other | Subscription |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Subscription.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public Subscription.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
mergeNotificationEndpoint(NotificationEndpoint value)
public Subscription.Builder mergeNotificationEndpoint(NotificationEndpoint value)
Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic.
.google.apps.events.subscriptions.v1.NotificationEndpoint notification_endpoint = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
value | NotificationEndpoint |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
mergePayloadOptions(PayloadOptions value)
public Subscription.Builder mergePayloadOptions(PayloadOptions value)
Optional. Options about what data to include in the event payload. Only supported for Google Chat events.
.google.apps.events.subscriptions.v1.PayloadOptions payload_options = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | PayloadOptions |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
mergeTtl(Duration value)
public Subscription.Builder mergeTtl(Duration value)
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];
Parameter | |
---|---|
Name | Description |
value | Duration |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Subscription.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
mergeUpdateTime(Timestamp value)
public Subscription.Builder mergeUpdateTime(Timestamp value)
Output only. The last time that the subscription is updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
setAuthority(String value)
public Subscription.Builder setAuthority(String value)
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
field from the Directory API.
string authority = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value | String The authority to set. |
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
setAuthorityBytes(ByteString value)
public Subscription.Builder setAuthorityBytes(ByteString value)
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
field from the Directory API.
string authority = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for authority to set. |
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
setCreateTime(Timestamp value)
public Subscription.Builder setCreateTime(Timestamp value)
Output only. The time when the subscription is created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public Subscription.Builder setCreateTime(Timestamp.Builder builderForValue)
Output only. The time when the subscription is created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
setEtag(String value)
public Subscription.Builder setEtag(String value)
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];
Parameter | |
---|---|
Name | Description |
value | String The etag to set. |
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
setEtagBytes(ByteString value)
public Subscription.Builder setEtagBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for etag to set. |
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
setEventTypes(int index, String value)
public Subscription.Builder setEventTypes(int index, String value)
Required. Immutable. 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.
By default, you also receive events about the lifecycle of your subscription. 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, (.google.api.field_behavior) = IMMUTABLE];
Parameters | |
---|---|
Name | Description |
index | int The index to set the value at. |
value | String The eventTypes to set. |
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
setExpireTime(Timestamp value)
public Subscription.Builder setExpireTime(Timestamp value)
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];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
setExpireTime(Timestamp.Builder builderForValue)
public Subscription.Builder setExpireTime(Timestamp.Builder builderForValue)
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];
Parameter | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public Subscription.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
setName(String value)
public Subscription.Builder setName(String value)
Optional. Immutable. Identifier. Resource name of the subscription.
Format: subscriptions/{subscription}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | String The name to set. |
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public Subscription.Builder setNameBytes(ByteString value)
Optional. Immutable. Identifier. Resource name of the subscription.
Format: subscriptions/{subscription}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
setNotificationEndpoint(NotificationEndpoint value)
public Subscription.Builder setNotificationEndpoint(NotificationEndpoint value)
Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic.
.google.apps.events.subscriptions.v1.NotificationEndpoint notification_endpoint = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
value | NotificationEndpoint |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
setNotificationEndpoint(NotificationEndpoint.Builder builderForValue)
public Subscription.Builder setNotificationEndpoint(NotificationEndpoint.Builder builderForValue)
Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic.
.google.apps.events.subscriptions.v1.NotificationEndpoint notification_endpoint = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
builderForValue | NotificationEndpoint.Builder |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
setPayloadOptions(PayloadOptions value)
public Subscription.Builder setPayloadOptions(PayloadOptions value)
Optional. Options about what data to include in the event payload. Only supported for Google Chat events.
.google.apps.events.subscriptions.v1.PayloadOptions payload_options = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | PayloadOptions |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
setPayloadOptions(PayloadOptions.Builder builderForValue)
public Subscription.Builder setPayloadOptions(PayloadOptions.Builder builderForValue)
Optional. Options about what data to include in the event payload. Only supported for Google Chat events.
.google.apps.events.subscriptions.v1.PayloadOptions payload_options = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue | PayloadOptions.Builder |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
setReconciling(boolean value)
public Subscription.Builder setReconciling(boolean value)
Output only. If true
, the subscription is in the process of being
updated.
bool reconciling = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | boolean The reconciling to set. |
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Subscription.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
setState(Subscription.State value)
public Subscription.Builder setState(Subscription.State value)
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.v1.Subscription.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | Subscription.State The state to set. |
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
setStateValue(int value)
public Subscription.Builder setStateValue(int value)
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.v1.Subscription.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | int The enum numeric value on the wire for state to set. |
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
setSuspensionReason(Subscription.ErrorType value)
public Subscription.Builder setSuspensionReason(Subscription.ErrorType value)
Output only. The error that suspended the subscription.
To reactivate the subscription, resolve the error and call the
ReactivateSubscription
method.
.google.apps.events.subscriptions.v1.Subscription.ErrorType suspension_reason = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | Subscription.ErrorType The suspensionReason to set. |
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
setSuspensionReasonValue(int value)
public Subscription.Builder setSuspensionReasonValue(int value)
Output only. The error that suspended the subscription.
To reactivate the subscription, resolve the error and call the
ReactivateSubscription
method.
.google.apps.events.subscriptions.v1.Subscription.ErrorType suspension_reason = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | int The enum numeric value on the wire for suspensionReason to set. |
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
setTargetResource(String value)
public Subscription.Builder setTargetResource(String value)
Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the full resource name. To learn about target resources and the events that they support, see Supported Google Workspace 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) = { ... }
Parameter | |
---|---|
Name | Description |
value | String The targetResource to set. |
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
setTargetResourceBytes(ByteString value)
public Subscription.Builder setTargetResourceBytes(ByteString value)
Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the full resource name. To learn about target resources and the events that they support, see Supported Google Workspace 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) = { ... }
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for targetResource to set. |
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
setTtl(Duration value)
public Subscription.Builder setTtl(Duration value)
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];
Parameter | |
---|---|
Name | Description |
value | Duration |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
setTtl(Duration.Builder builderForValue)
public Subscription.Builder setTtl(Duration.Builder builderForValue)
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];
Parameter | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
setUid(String value)
public Subscription.Builder setUid(String value)
Output only. System-assigned unique identifier for the subscription.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | String The uid to set. |
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
setUidBytes(ByteString value)
public Subscription.Builder setUidBytes(ByteString value)
Output only. System-assigned unique identifier for the subscription.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for uid to set. |
Returns | |
---|---|
Type | Description |
Subscription.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Subscription.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
setUpdateTime(Timestamp value)
public Subscription.Builder setUpdateTime(Timestamp value)
Output only. The last time that the subscription is updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
Subscription.Builder |
setUpdateTime(Timestamp.Builder builderForValue)
public Subscription.Builder setUpdateTime(Timestamp.Builder builderForValue)
Output only. The last time that the subscription is updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
Subscription.Builder |