Constructor Detail

Method Detail

• id

   final SubscriptionCreateParams.Builder id(String id)

• id

   final SubscriptionCreateParams.Builder id(Optional<String> id)

  Alias for calling Builder.id with id.orElse(null).

• body

   final SubscriptionCreateParams.Builder body(SubscriptionCreateParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • callbackUrl

  • eventTypes

  • objectIds

  • signingSecret

• callbackUrl

   final SubscriptionCreateParams.Builder callbackUrl(String callbackUrl)

  Webhook endpoint URL that will receive vault event deliveries

• callbackUrl

   final SubscriptionCreateParams.Builder callbackUrl(JsonField<String> callbackUrl)

  Sets Builder.callbackUrl to an arbitrary JSON value.

  You should usually call Builder.callbackUrl with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• eventTypes

   final SubscriptionCreateParams.Builder eventTypes(List<String> eventTypes)

  Vault event types to deliver. Omit to receive the default supported set.

• eventTypes

   final SubscriptionCreateParams.Builder eventTypes(JsonField<List<String>> eventTypes)

  Sets Builder.eventTypes to an arbitrary JSON value.

  You should usually call Builder.eventTypes with a well-typed List<String> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addEventType

   final SubscriptionCreateParams.Builder addEventType(String eventType)

  Adds a single String to eventTypes.

• objectIds

   final SubscriptionCreateParams.Builder objectIds(List<String> objectIds)

  Vault object IDs to limit notifications to. Omit to receive events for all objects in the vault.

• objectIds

   final SubscriptionCreateParams.Builder objectIds(JsonField<List<String>> objectIds)

  Sets Builder.objectIds to an arbitrary JSON value.

  You should usually call Builder.objectIds with a well-typed List<String> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addObjectId

   final SubscriptionCreateParams.Builder addObjectId(String objectId)

  Adds a single String to objectIds.

• signingSecret

   final SubscriptionCreateParams.Builder signingSecret(String signingSecret)

  Optional secret used to sign outbound webhook deliveries

• signingSecret

   final SubscriptionCreateParams.Builder signingSecret(JsonField<String> signingSecret)

  Sets Builder.signingSecret to an arbitrary JSON value.

  You should usually call Builder.signingSecret with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalBodyProperties

   final SubscriptionCreateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final SubscriptionCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final SubscriptionCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final SubscriptionCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final SubscriptionCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final SubscriptionCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final SubscriptionCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final SubscriptionCreateParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final SubscriptionCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final SubscriptionCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final SubscriptionCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final SubscriptionCreateParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final SubscriptionCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final SubscriptionCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final SubscriptionCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final SubscriptionCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final SubscriptionCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final SubscriptionCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final SubscriptionCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final SubscriptionCreateParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final SubscriptionCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final SubscriptionCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final SubscriptionCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final SubscriptionCreateParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final SubscriptionCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final SubscriptionCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final SubscriptionCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final SubscriptionCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final SubscriptionCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final SubscriptionCreateParams build()

  Returns an immutable instance of SubscriptionCreateParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .callbackUrl()