Class GetMembershipRequest.Builder (0.18.0)

public static final class GetMembershipRequest.Builder extends GeneratedMessageV3.Builder<GetMembershipRequest.Builder> implements GetMembershipRequestOrBuilder

Request to get a membership of a space.

Protobuf type google.chat.v1.GetMembershipRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GetMembershipRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GetMembershipRequest.Builder
Overrides

build()

public GetMembershipRequest build()
Returns
Type Description
GetMembershipRequest

buildPartial()

public GetMembershipRequest buildPartial()
Returns
Type Description
GetMembershipRequest

clear()

public GetMembershipRequest.Builder clear()
Returns
Type Description
GetMembershipRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public GetMembershipRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
GetMembershipRequest.Builder
Overrides

clearName()

public GetMembershipRequest.Builder clearName()

Required. Resource name of the membership to retrieve.

To get the app's own membership by using user authentication, you can optionally use spaces/{space}/members/app.

Format: spaces/{space}/members/{member} or spaces/{space}/members/app

When authenticated as a user, you can use the user's email as an alias for {member}. For example, spaces/{space}/members/example@gmail.com where example@gmail.com is the email of the Google Chat user.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
GetMembershipRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GetMembershipRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
GetMembershipRequest.Builder
Overrides

clearUseAdminAccess()

public GetMembershipRequest.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 or chat.admin.memberships.readonly OAuth 2.0 scopes.

Getting app memberships in a space isn't supported when using admin access.

bool use_admin_access = 3;

Returns
Type Description
GetMembershipRequest.Builder

This builder for chaining.

clone()

public GetMembershipRequest.Builder clone()
Returns
Type Description
GetMembershipRequest.Builder
Overrides

getDefaultInstanceForType()

public GetMembershipRequest getDefaultInstanceForType()
Returns
Type Description
GetMembershipRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getName()

public String getName()

Required. Resource name of the membership to retrieve.

To get the app's own membership by using user authentication, you can optionally use spaces/{space}/members/app.

Format: spaces/{space}/members/{member} or spaces/{space}/members/app

When authenticated as a user, you can use the user's email as an alias for {member}. For example, spaces/{space}/members/example@gmail.com where example@gmail.com is the email of the Google Chat user.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. Resource name of the membership to retrieve.

To get the app's own membership by using user authentication, you can optionally use spaces/{space}/members/app.

Format: spaces/{space}/members/{member} or spaces/{space}/members/app

When authenticated as a user, you can use the user's email as an alias for {member}. For example, spaces/{space}/members/example@gmail.com where example@gmail.com is the email of the Google Chat user.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

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 or chat.admin.memberships.readonly OAuth 2.0 scopes.

Getting app memberships in a space isn't supported when using admin access.

bool use_admin_access = 3;

Returns
Type Description
boolean

The useAdminAccess.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(GetMembershipRequest other)

public GetMembershipRequest.Builder mergeFrom(GetMembershipRequest other)
Parameter
Name Description
other GetMembershipRequest
Returns
Type Description
GetMembershipRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GetMembershipRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetMembershipRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public GetMembershipRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
GetMembershipRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GetMembershipRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GetMembershipRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public GetMembershipRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GetMembershipRequest.Builder
Overrides

setName(String value)

public GetMembershipRequest.Builder setName(String value)

Required. Resource name of the membership to retrieve.

To get the app's own membership by using user authentication, you can optionally use spaces/{space}/members/app.

Format: spaces/{space}/members/{member} or spaces/{space}/members/app

When authenticated as a user, you can use the user's email as an alias for {member}. For example, spaces/{space}/members/example@gmail.com where example@gmail.com is the email of the Google Chat user.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
GetMembershipRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public GetMembershipRequest.Builder setNameBytes(ByteString value)

Required. Resource name of the membership to retrieve.

To get the app's own membership by using user authentication, you can optionally use spaces/{space}/members/app.

Format: spaces/{space}/members/{member} or spaces/{space}/members/app

When authenticated as a user, you can use the user's email as an alias for {member}. For example, spaces/{space}/members/example@gmail.com where example@gmail.com is the email of the Google Chat user.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
GetMembershipRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GetMembershipRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
GetMembershipRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final GetMembershipRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GetMembershipRequest.Builder
Overrides

setUseAdminAccess(boolean value)

public GetMembershipRequest.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 or chat.admin.memberships.readonly OAuth 2.0 scopes.

Getting app memberships in a space isn't supported when using admin access.

bool use_admin_access = 3;

Parameter
Name Description
value boolean

The useAdminAccess to set.

Returns
Type Description
GetMembershipRequest.Builder

This builder for chaining.