Constructor Detail

Method Detail

• body

   final RoleCreateParams.Builder body(RoleCreateParams.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:

  • name

  • description

  • memberPermissions

  • memberRoles

  • orgName

  • etc.

• name

   final RoleCreateParams.Builder name(String name)

  Name of the role

• name

   final RoleCreateParams.Builder name(JsonField<String> name)

  Sets Builder.name to an arbitrary JSON value.

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

• description

   final RoleCreateParams.Builder description(String description)

  Textual description of the role

• description

   final RoleCreateParams.Builder description(Optional<String> description)

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

• description

   final RoleCreateParams.Builder description(JsonField<String> description)

  Sets Builder.description to an arbitrary JSON value.

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

• memberPermissions

   final RoleCreateParams.Builder memberPermissions(List<RoleCreateParams.MemberPermission> memberPermissions)

  (permission, restrict_object_type) tuples which belong to this role

• memberPermissions

   final RoleCreateParams.Builder memberPermissions(Optional<List<RoleCreateParams.MemberPermission>> memberPermissions)

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

• memberPermissions

   final RoleCreateParams.Builder memberPermissions(JsonField<List<RoleCreateParams.MemberPermission>> memberPermissions)

  Sets Builder.memberPermissions to an arbitrary JSON value.

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

• addMemberPermission

   final RoleCreateParams.Builder addMemberPermission(RoleCreateParams.MemberPermission memberPermission)

  Adds a single MemberPermission to memberPermissions.

• memberRoles

   final RoleCreateParams.Builder memberRoles(List<String> memberRoles)

  Ids of the roles this role inherits from

  An inheriting role has all the permissions contained in its member roles, as well as all of their inherited permissions

• memberRoles

   final RoleCreateParams.Builder memberRoles(Optional<List<String>> memberRoles)

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

• memberRoles

   final RoleCreateParams.Builder memberRoles(JsonField<List<String>> memberRoles)

  Sets Builder.memberRoles to an arbitrary JSON value.

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

• addMemberRole

   final RoleCreateParams.Builder addMemberRole(String memberRole)

  Adds a single String to memberRoles.

• orgName

   final RoleCreateParams.Builder orgName(String orgName)

  For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, you may specify the name of the organization the role belongs in.

• orgName

   final RoleCreateParams.Builder orgName(Optional<String> orgName)

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

• orgName

   final RoleCreateParams.Builder orgName(JsonField<String> orgName)

  Sets Builder.orgName to an arbitrary JSON value.

  You should usually call Builder.orgName 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 RoleCreateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

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

• putAllAdditionalBodyProperties

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

• removeAdditionalBodyProperty

   final RoleCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

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

• additionalHeaders

   final RoleCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

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

• putAdditionalHeader

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

• putAdditionalHeaders

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

• putAllAdditionalHeaders

   final RoleCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAllAdditionalHeaders

   final RoleCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

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

• removeAdditionalHeaders

   final RoleCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

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

• additionalQueryParams

   final RoleCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

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

• putAdditionalQueryParam

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

• putAdditionalQueryParams

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

• putAllAdditionalQueryParams

   final RoleCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAllAdditionalQueryParams

   final RoleCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

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

• removeAdditionalQueryParams

   final RoleCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

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

• build

   final RoleCreateParams build()

  Returns an immutable instance of RoleCreateParams.

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

  The following fields are required:

  .name()