public static final class CreateMembershipRequest.Builder extends GeneratedMessageV3.Builder<CreateMembershipRequest.Builder> implements CreateMembershipRequestOrBuilderRequest message for creating a membership.
Protobuf type google.chat.v1.CreateMembershipRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CreateMembershipRequest.BuilderImplements
CreateMembershipRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CreateMembershipRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
|
build()
public CreateMembershipRequest build()| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest |
|
buildPartial()
public CreateMembershipRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest |
|
clear()
public CreateMembershipRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public CreateMembershipRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
|
clearMembership()
public CreateMembershipRequest.Builder clearMembership() Required. The membership relation to create.
The memberType field must contain a user with the user.name and
user.type fields populated. The server will assign a resource name
and overwrite anything specified.
When a Chat app creates a membership relation for a human user, it must use
the chat.memberships scope, set user.type to HUMAN, and set
user.name with format users/{user}, where {user} can be the email
address for the user. For users in the same Workspace organization {user}
can also be the id of the
person from the
People API, or the id for the user in the Directory API. For example, if
the People API Person profile ID for user@example.com is 123456789, you
can add the user to the space by setting the membership.member.name to
users/user@example.com or users/123456789. When a Chat app creates a
membership relation for itself, it must use the chat.memberships.app
scope, set user.type to BOT, and set user.name to users/app.
.google.chat.v1.Membership membership = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public CreateMembershipRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
|
clearParent()
public CreateMembershipRequest.Builder clearParent()Required. The resource name of the space for which to create the membership.
Format: spaces/{space}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
This builder for chaining. |
clearUseAdminAccess()
public CreateMembershipRequest.Builder clearUseAdminAccess() When true, the method runs using the user's Google Workspace
administrator privileges.
The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.
Requires the chat.admin.memberships OAuth 2.0
scope.
Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access.
bool use_admin_access = 5;
| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
This builder for chaining. |
clone()
public CreateMembershipRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
|
getDefaultInstanceForType()
public CreateMembershipRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getMembership()
public Membership getMembership() Required. The membership relation to create.
The memberType field must contain a user with the user.name and
user.type fields populated. The server will assign a resource name
and overwrite anything specified.
When a Chat app creates a membership relation for a human user, it must use
the chat.memberships scope, set user.type to HUMAN, and set
user.name with format users/{user}, where {user} can be the email
address for the user. For users in the same Workspace organization {user}
can also be the id of the
person from the
People API, or the id for the user in the Directory API. For example, if
the People API Person profile ID for user@example.com is 123456789, you
can add the user to the space by setting the membership.member.name to
users/user@example.com or users/123456789. When a Chat app creates a
membership relation for itself, it must use the chat.memberships.app
scope, set user.type to BOT, and set user.name to users/app.
.google.chat.v1.Membership membership = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Membership |
The membership. |
getMembershipBuilder()
public Membership.Builder getMembershipBuilder() Required. The membership relation to create.
The memberType field must contain a user with the user.name and
user.type fields populated. The server will assign a resource name
and overwrite anything specified.
When a Chat app creates a membership relation for a human user, it must use
the chat.memberships scope, set user.type to HUMAN, and set
user.name with format users/{user}, where {user} can be the email
address for the user. For users in the same Workspace organization {user}
can also be the id of the
person from the
People API, or the id for the user in the Directory API. For example, if
the People API Person profile ID for user@example.com is 123456789, you
can add the user to the space by setting the membership.member.name to
users/user@example.com or users/123456789. When a Chat app creates a
membership relation for itself, it must use the chat.memberships.app
scope, set user.type to BOT, and set user.name to users/app.
.google.chat.v1.Membership membership = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Membership.Builder |
|
getMembershipOrBuilder()
public MembershipOrBuilder getMembershipOrBuilder() Required. The membership relation to create.
The memberType field must contain a user with the user.name and
user.type fields populated. The server will assign a resource name
and overwrite anything specified.
When a Chat app creates a membership relation for a human user, it must use
the chat.memberships scope, set user.type to HUMAN, and set
user.name with format users/{user}, where {user} can be the email
address for the user. For users in the same Workspace organization {user}
can also be the id of the
person from the
People API, or the id for the user in the Directory API. For example, if
the People API Person profile ID for user@example.com is 123456789, you
can add the user to the space by setting the membership.member.name to
users/user@example.com or users/123456789. When a Chat app creates a
membership relation for itself, it must use the chat.memberships.app
scope, set user.type to BOT, and set user.name to users/app.
.google.chat.v1.Membership membership = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
MembershipOrBuilder |
|
getParent()
public String getParent()Required. The resource name of the space for which to create the membership.
Format: spaces/{space}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The parent. |
getParentBytes()
public ByteString getParentBytes()Required. The resource name of the space for which to create the membership.
Format: spaces/{space}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
getUseAdminAccess()
public boolean getUseAdminAccess() When true, the method runs using the user's Google Workspace
administrator privileges.
The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.
Requires the chat.admin.memberships OAuth 2.0
scope.
Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access.
bool use_admin_access = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
The useAdminAccess. |
hasMembership()
public boolean hasMembership() Required. The membership relation to create.
The memberType field must contain a user with the user.name and
user.type fields populated. The server will assign a resource name
and overwrite anything specified.
When a Chat app creates a membership relation for a human user, it must use
the chat.memberships scope, set user.type to HUMAN, and set
user.name with format users/{user}, where {user} can be the email
address for the user. For users in the same Workspace organization {user}
can also be the id of the
person from the
People API, or the id for the user in the Directory API. For example, if
the People API Person profile ID for user@example.com is 123456789, you
can add the user to the space by setting the membership.member.name to
users/user@example.com or users/123456789. When a Chat app creates a
membership relation for itself, it must use the chat.memberships.app
scope, set user.type to BOT, and set user.name to users/app.
.google.chat.v1.Membership membership = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the membership field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(CreateMembershipRequest other)
public CreateMembershipRequest.Builder mergeFrom(CreateMembershipRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
CreateMembershipRequest |
| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CreateMembershipRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CreateMembershipRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
|
mergeMembership(Membership value)
public CreateMembershipRequest.Builder mergeMembership(Membership value) Required. The membership relation to create.
The memberType field must contain a user with the user.name and
user.type fields populated. The server will assign a resource name
and overwrite anything specified.
When a Chat app creates a membership relation for a human user, it must use
the chat.memberships scope, set user.type to HUMAN, and set
user.name with format users/{user}, where {user} can be the email
address for the user. For users in the same Workspace organization {user}
can also be the id of the
person from the
People API, or the id for the user in the Directory API. For example, if
the People API Person profile ID for user@example.com is 123456789, you
can add the user to the space by setting the membership.member.name to
users/user@example.com or users/123456789. When a Chat app creates a
membership relation for itself, it must use the chat.memberships.app
scope, set user.type to BOT, and set user.name to users/app.
.google.chat.v1.Membership membership = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
Membership |
| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CreateMembershipRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public CreateMembershipRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
|
setMembership(Membership value)
public CreateMembershipRequest.Builder setMembership(Membership value) Required. The membership relation to create.
The memberType field must contain a user with the user.name and
user.type fields populated. The server will assign a resource name
and overwrite anything specified.
When a Chat app creates a membership relation for a human user, it must use
the chat.memberships scope, set user.type to HUMAN, and set
user.name with format users/{user}, where {user} can be the email
address for the user. For users in the same Workspace organization {user}
can also be the id of the
person from the
People API, or the id for the user in the Directory API. For example, if
the People API Person profile ID for user@example.com is 123456789, you
can add the user to the space by setting the membership.member.name to
users/user@example.com or users/123456789. When a Chat app creates a
membership relation for itself, it must use the chat.memberships.app
scope, set user.type to BOT, and set user.name to users/app.
.google.chat.v1.Membership membership = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
Membership |
| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
|
setMembership(Membership.Builder builderForValue)
public CreateMembershipRequest.Builder setMembership(Membership.Builder builderForValue) Required. The membership relation to create.
The memberType field must contain a user with the user.name and
user.type fields populated. The server will assign a resource name
and overwrite anything specified.
When a Chat app creates a membership relation for a human user, it must use
the chat.memberships scope, set user.type to HUMAN, and set
user.name with format users/{user}, where {user} can be the email
address for the user. For users in the same Workspace organization {user}
can also be the id of the
person from the
People API, or the id for the user in the Directory API. For example, if
the People API Person profile ID for user@example.com is 123456789, you
can add the user to the space by setting the membership.member.name to
users/user@example.com or users/123456789. When a Chat app creates a
membership relation for itself, it must use the chat.memberships.app
scope, set user.type to BOT, and set user.name to users/app.
.google.chat.v1.Membership membership = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Membership.Builder |
| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
|
setParent(String value)
public CreateMembershipRequest.Builder setParent(String value)Required. The resource name of the space for which to create the membership.
Format: spaces/{space}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public CreateMembershipRequest.Builder setParentBytes(ByteString value)Required. The resource name of the space for which to create the membership.
Format: spaces/{space}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CreateMembershipRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final CreateMembershipRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
|
setUseAdminAccess(boolean value)
public CreateMembershipRequest.Builder setUseAdminAccess(boolean value) When true, the method runs using the user's Google Workspace
administrator privileges.
The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.
Requires the chat.admin.memberships OAuth 2.0
scope.
Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access.
bool use_admin_access = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe useAdminAccess to set. |
| Returns | |
|---|---|
| Type | Description |
CreateMembershipRequest.Builder |
This builder for chaining. |