public final class CreateMembershipRequest extends GeneratedMessageV3 implements CreateMembershipRequestOrBuilder
Request message for creating a membership.
Protobuf type google.chat.v1.CreateMembershipRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
MEMBERSHIP_FIELD_NUMBER
public static final int MEMBERSHIP_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
USE_ADMIN_ACCESS_FIELD_NUMBER
public static final int USE_ADMIN_ACCESS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static CreateMembershipRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CreateMembershipRequest.Builder newBuilder()
newBuilder(CreateMembershipRequest prototype)
public static CreateMembershipRequest.Builder newBuilder(CreateMembershipRequest prototype)
public static CreateMembershipRequest parseDelimitedFrom(InputStream input)
public static CreateMembershipRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CreateMembershipRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CreateMembershipRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CreateMembershipRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CreateMembershipRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CreateMembershipRequest parseFrom(CodedInputStream input)
public static CreateMembershipRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CreateMembershipRequest parseFrom(InputStream input)
public static CreateMembershipRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CreateMembershipRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CreateMembershipRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CreateMembershipRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public CreateMembershipRequest getDefaultInstanceForType()
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
certain authorization scopes and set specific values for certain fields:
When authenticating as a
user,
the chat.memberships authorization scope is required.
When authenticating as an
app,
the chat.app.memberships authorization scope is required.
Authenticating as an app is available in Developer
Preview.
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.
Inviting users external to the Workspace organization that owns the space
requires user
authentication.
When a Chat app creates a membership relation for itself, it must
authenticate as a
user
and 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.
|
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
certain authorization scopes and set specific values for certain fields:
When authenticating as a
user,
the chat.memberships authorization scope is required.
When authenticating as an
app,
the chat.app.memberships authorization scope is required.
Authenticating as an app is available in Developer
Preview.
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.
Inviting users external to the Workspace organization that owns the space
requires user
authentication.
When a Chat app creates a membership relation for itself, it must
authenticate as a
user
and 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];
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.
|
getParserForType()
public Parser<CreateMembershipRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getUseAdminAccess()
public boolean getUseAdminAccess()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| 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
certain authorization scopes and set specific values for certain fields:
When authenticating as a
user,
the chat.memberships authorization scope is required.
When authenticating as an
app,
the chat.app.memberships authorization scope is required.
Authenticating as an app is available in Developer
Preview.
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.
Inviting users external to the Workspace organization that owns the space
requires user
authentication.
When a Chat app creates a membership relation for itself, it must
authenticate as a
user
and 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CreateMembershipRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CreateMembershipRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public CreateMembershipRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
