Class SpacesServiceClient (0.24.0)

GitHub RepositoryProduct Reference

Service Description: REST API for services dealing with spaces.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   Space space = Space.newBuilder().build();
   Space response = spacesServiceClient.createSpace(space);
 }

Note: close() needs to be called on the SpacesServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

CreateSpace

Creates a space.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createSpace(CreateSpaceRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createSpace(Space space)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createSpaceCallable()

GetSpace

Gets details about a meeting space.

For an example, see Get a meeting space.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getSpace(GetSpaceRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getSpace(SpaceName name)

  • getSpace(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getSpaceCallable()

UpdateSpace

Updates details about a meeting space.

For an example, see Update a meeting space.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateSpace(UpdateSpaceRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateSpace(Space space, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateSpaceCallable()

EndActiveConference

Ends an active conference (if there's one).

For an example, see End active conference.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • endActiveConference(EndActiveConferenceRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • endActiveConference(SpaceName name)

  • endActiveConference(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • endActiveConferenceCallable()

CreateMember

Developer Preview: Create a member.

This API supports the fields parameter in SystemParameterContext. When the fields parameter is omitted, this API response will default to "name,email,role,user".

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createMember(CreateMemberRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createMember(SpaceName parent, Member member)

  • createMember(String parent, Member member)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createMemberCallable()

GetMember

Developer Preview: Get a member.

This API supports the fields parameter in SystemParameterContext. When the fields parameter is omitted, this API response will default to "name,email,role,user".

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getMember(GetMemberRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getMember(MemberName name)

  • getMember(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getMemberCallable()

ListMembers

Developer Preview: List members.

This API supports the fields parameter in SystemParameterContext. When the fields parameter is omitted this API response will default to "name,email,role,user".

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listMembers(ListMembersRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listMembers(SpaceName parent)

  • listMembers(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listMembersPagedCallable()

  • listMembersCallable()

DeleteMember

Developer Preview: Delete the member who was previously assigned roles in the space.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteMember(DeleteMemberRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteMember(MemberName name)

  • deleteMember(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteMemberCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of SpacesServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SpacesServiceSettings spacesServiceSettings =
     SpacesServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SpacesServiceClient spacesServiceClient = SpacesServiceClient.create(spacesServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SpacesServiceSettings spacesServiceSettings =
     SpacesServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SpacesServiceClient spacesServiceClient = SpacesServiceClient.create(spacesServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SpacesServiceSettings spacesServiceSettings =
     SpacesServiceSettings.newHttpJsonBuilder().build();
 SpacesServiceClient spacesServiceClient = SpacesServiceClient.create(spacesServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > SpacesServiceClient

Static Methods

create()

public static final SpacesServiceClient create()

Constructs an instance of SpacesServiceClient with default settings.

Returns
Type Description
SpacesServiceClient
Exceptions
Type Description
IOException

create(SpacesServiceSettings settings)

public static final SpacesServiceClient create(SpacesServiceSettings settings)

Constructs an instance of SpacesServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings SpacesServiceSettings
Returns
Type Description
SpacesServiceClient
Exceptions
Type Description
IOException

create(SpacesServiceStub stub)

public static final SpacesServiceClient create(SpacesServiceStub stub)

Constructs an instance of SpacesServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(SpacesServiceSettings).

Parameter
Name Description
stub SpacesServiceStub
Returns
Type Description
SpacesServiceClient

Constructors

SpacesServiceClient(SpacesServiceSettings settings)

protected SpacesServiceClient(SpacesServiceSettings settings)

Constructs an instance of SpacesServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings SpacesServiceSettings

SpacesServiceClient(SpacesServiceStub stub)

protected SpacesServiceClient(SpacesServiceStub stub)
Parameter
Name Description
stub SpacesServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createMember(CreateMemberRequest request)

public final Member createMember(CreateMemberRequest request)

Developer Preview: Create a member.

This API supports the fields parameter in SystemParameterContext. When the fields parameter is omitted, this API response will default to "name,email,role,user".

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   CreateMemberRequest request =
       CreateMemberRequest.newBuilder()
           .setParent(SpaceName.of("[SPACE]").toString())
           .setMember(Member.newBuilder().build())
           .build();
   Member response = spacesServiceClient.createMember(request);
 }
Parameter
Name Description
request CreateMemberRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Member

createMember(SpaceName parent, Member member)

public final Member createMember(SpaceName parent, Member member)

Developer Preview: Create a member.

This API supports the fields parameter in SystemParameterContext. When the fields parameter is omitted, this API response will default to "name,email,role,user".

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   SpaceName parent = SpaceName.of("[SPACE]");
   Member member = Member.newBuilder().build();
   Member response = spacesServiceClient.createMember(parent, member);
 }
Parameters
Name Description
parent SpaceName

Required. Format: spaces/{space}
member Member

Required. The member to be created.
Returns
Type Description
Member

createMember(String parent, Member member)

public final Member createMember(String parent, Member member)

Developer Preview: Create a member.

This API supports the fields parameter in SystemParameterContext. When the fields parameter is omitted, this API response will default to "name,email,role,user".

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   String parent = SpaceName.of("[SPACE]").toString();
   Member member = Member.newBuilder().build();
   Member response = spacesServiceClient.createMember(parent, member);
 }
Parameters
Name Description
parent String

Required. Format: spaces/{space}
member Member

Required. The member to be created.
Returns
Type Description
Member

createMemberCallable()

public final UnaryCallable<CreateMemberRequest,Member> createMemberCallable()

Developer Preview: Create a member.

This API supports the fields parameter in SystemParameterContext. When the fields parameter is omitted, this API response will default to "name,email,role,user".

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   CreateMemberRequest request =
       CreateMemberRequest.newBuilder()
           .setParent(SpaceName.of("[SPACE]").toString())
           .setMember(Member.newBuilder().build())
           .build();
   ApiFuture<Member> future = spacesServiceClient.createMemberCallable().futureCall(request);
   // Do something.
   Member response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateMemberRequest,Member>

createSpace(CreateSpaceRequest request)

public final Space createSpace(CreateSpaceRequest request)

Creates a space.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   CreateSpaceRequest request =
       CreateSpaceRequest.newBuilder().setSpace(Space.newBuilder().build()).build();
   Space response = spacesServiceClient.createSpace(request);
 }
Parameter
Name Description
request CreateSpaceRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Space

createSpace(Space space)

public final Space createSpace(Space space)

Creates a space.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   Space space = Space.newBuilder().build();
   Space response = spacesServiceClient.createSpace(space);
 }
Parameter
Name Description
space Space

Space to be created. As of May 2023, the input space can be empty. Later on the input space can be non-empty when space configuration is introduced.
Returns
Type Description
Space

createSpaceCallable()

public final UnaryCallable<CreateSpaceRequest,Space> createSpaceCallable()

Creates a space.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   CreateSpaceRequest request =
       CreateSpaceRequest.newBuilder().setSpace(Space.newBuilder().build()).build();
   ApiFuture<Space> future = spacesServiceClient.createSpaceCallable().futureCall(request);
   // Do something.
   Space response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateSpaceRequest,Space>

deleteMember(DeleteMemberRequest request)

public final void deleteMember(DeleteMemberRequest request)

Developer Preview: Delete the member who was previously assigned roles in the space.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   DeleteMemberRequest request =
       DeleteMemberRequest.newBuilder()
           .setName(MemberName.of("[SPACE]", "[MEMBER]").toString())
           .build();
   spacesServiceClient.deleteMember(request);
 }
Parameter
Name Description
request DeleteMemberRequest

The request object containing all of the parameters for the API call.

deleteMember(MemberName name)

public final void deleteMember(MemberName name)

Developer Preview: Delete the member who was previously assigned roles in the space.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   MemberName name = MemberName.of("[SPACE]", "[MEMBER]");
   spacesServiceClient.deleteMember(name);
 }
Parameter
Name Description
name MemberName

Required. Format: “spaces/{space}/members/{member}”

deleteMember(String name)

public final void deleteMember(String name)

Developer Preview: Delete the member who was previously assigned roles in the space.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   String name = MemberName.of("[SPACE]", "[MEMBER]").toString();
   spacesServiceClient.deleteMember(name);
 }
Parameter
Name Description
name String

Required. Format: “spaces/{space}/members/{member}”

deleteMemberCallable()

public final UnaryCallable<DeleteMemberRequest,Empty> deleteMemberCallable()

Developer Preview: Delete the member who was previously assigned roles in the space.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   DeleteMemberRequest request =
       DeleteMemberRequest.newBuilder()
           .setName(MemberName.of("[SPACE]", "[MEMBER]").toString())
           .build();
   ApiFuture<Empty> future = spacesServiceClient.deleteMemberCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteMemberRequest,Empty>

endActiveConference(EndActiveConferenceRequest request)

public final void endActiveConference(EndActiveConferenceRequest request)

Ends an active conference (if there's one).

For an example, see End active conference.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   EndActiveConferenceRequest request =
       EndActiveConferenceRequest.newBuilder()
           .setName(SpaceName.of("[SPACE]").toString())
           .build();
   spacesServiceClient.endActiveConference(request);
 }
Parameter
Name Description
request EndActiveConferenceRequest

The request object containing all of the parameters for the API call.

endActiveConference(SpaceName name)

public final void endActiveConference(SpaceName name)

Ends an active conference (if there's one).

For an example, see End active conference.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   SpaceName name = SpaceName.of("[SPACE]");
   spacesServiceClient.endActiveConference(name);
 }
Parameter
Name Description
name SpaceName

Required. Resource name of the space.

Format: spaces/{space}.

{space} is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, jQCFfuBOdN5z.

For more information, see How Meet identifies a meeting space.

endActiveConference(String name)

public final void endActiveConference(String name)

Ends an active conference (if there's one).

For an example, see End active conference.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   String name = SpaceName.of("[SPACE]").toString();
   spacesServiceClient.endActiveConference(name);
 }
Parameter
Name Description
name String

Required. Resource name of the space.

Format: spaces/{space}.

{space} is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, jQCFfuBOdN5z.

For more information, see How Meet identifies a meeting space.

endActiveConferenceCallable()

public final UnaryCallable<EndActiveConferenceRequest,Empty> endActiveConferenceCallable()

Ends an active conference (if there's one).

For an example, see End active conference.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   EndActiveConferenceRequest request =
       EndActiveConferenceRequest.newBuilder()
           .setName(SpaceName.of("[SPACE]").toString())
           .build();
   ApiFuture<Empty> future =
       spacesServiceClient.endActiveConferenceCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<EndActiveConferenceRequest,Empty>

getMember(GetMemberRequest request)

public final Member getMember(GetMemberRequest request)

Developer Preview: Get a member.

This API supports the fields parameter in SystemParameterContext. When the fields parameter is omitted, this API response will default to "name,email,role,user".

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   GetMemberRequest request =
       GetMemberRequest.newBuilder()
           .setName(MemberName.of("[SPACE]", "[MEMBER]").toString())
           .build();
   Member response = spacesServiceClient.getMember(request);
 }
Parameter
Name Description
request GetMemberRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Member

getMember(MemberName name)

public final Member getMember(MemberName name)

Developer Preview: Get a member.

This API supports the fields parameter in SystemParameterContext. When the fields parameter is omitted, this API response will default to "name,email,role,user".

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   MemberName name = MemberName.of("[SPACE]", "[MEMBER]");
   Member response = spacesServiceClient.getMember(name);
 }
Parameter
Name Description
name MemberName

Required. Format: “spaces/{space}/members/{member}”
Returns
Type Description
Member

getMember(String name)

public final Member getMember(String name)

Developer Preview: Get a member.

This API supports the fields parameter in SystemParameterContext. When the fields parameter is omitted, this API response will default to "name,email,role,user".

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   String name = MemberName.of("[SPACE]", "[MEMBER]").toString();
   Member response = spacesServiceClient.getMember(name);
 }
Parameter
Name Description
name String

Required. Format: “spaces/{space}/members/{member}”
Returns
Type Description
Member

getMemberCallable()

public final UnaryCallable<GetMemberRequest,Member> getMemberCallable()

Developer Preview: Get a member.

This API supports the fields parameter in SystemParameterContext. When the fields parameter is omitted, this API response will default to "name,email,role,user".

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   GetMemberRequest request =
       GetMemberRequest.newBuilder()
           .setName(MemberName.of("[SPACE]", "[MEMBER]").toString())
           .build();
   ApiFuture<Member> future = spacesServiceClient.getMemberCallable().futureCall(request);
   // Do something.
   Member response = future.get();
 }
Returns
Type Description
UnaryCallable<GetMemberRequest,Member>

getSettings()

public final SpacesServiceSettings getSettings()
Returns
Type Description
SpacesServiceSettings

getSpace(GetSpaceRequest request)

public final Space getSpace(GetSpaceRequest request)

Gets details about a meeting space.

For an example, see Get a meeting space.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   GetSpaceRequest request =
       GetSpaceRequest.newBuilder().setName(SpaceName.of("[SPACE]").toString()).build();
   Space response = spacesServiceClient.getSpace(request);
 }
Parameter
Name Description
request GetSpaceRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Space

getSpace(SpaceName name)

public final Space getSpace(SpaceName name)

Gets details about a meeting space.

For an example, see Get a meeting space.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   SpaceName name = SpaceName.of("[SPACE]");
   Space response = spacesServiceClient.getSpace(name);
 }
Parameter
Name Description
name SpaceName

Required. Resource name of the space.

Format: spaces/{space} or spaces/{meetingCode}.

{space} is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, jQCFfuBOdN5z.

{meetingCode} is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, abc-mnop-xyz. The maximum length is 128 characters.

A meetingCode shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a meetingCode expires 365 days after last use. For more information, see Learn about meeting codes in Google Meet.

For more information, see How Meet identifies a meeting space.
Returns
Type Description
Space

getSpace(String name)

public final Space getSpace(String name)

Gets details about a meeting space.

For an example, see Get a meeting space.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   String name = SpaceName.of("[SPACE]").toString();
   Space response = spacesServiceClient.getSpace(name);
 }
Parameter
Name Description
name String

Required. Resource name of the space.

Format: spaces/{space} or spaces/{meetingCode}.

{space} is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, jQCFfuBOdN5z.

{meetingCode} is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, abc-mnop-xyz. The maximum length is 128 characters.

A meetingCode shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a meetingCode expires 365 days after last use. For more information, see Learn about meeting codes in Google Meet.

For more information, see How Meet identifies a meeting space.
Returns
Type Description
Space

getSpaceCallable()

public final UnaryCallable<GetSpaceRequest,Space> getSpaceCallable()

Gets details about a meeting space.

For an example, see Get a meeting space.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   GetSpaceRequest request =
       GetSpaceRequest.newBuilder().setName(SpaceName.of("[SPACE]").toString()).build();
   ApiFuture<Space> future = spacesServiceClient.getSpaceCallable().futureCall(request);
   // Do something.
   Space response = future.get();
 }
Returns
Type Description
UnaryCallable<GetSpaceRequest,Space>

getStub()

public SpacesServiceStub getStub()
Returns
Type Description
SpacesServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listMembers(ListMembersRequest request)

public final SpacesServiceClient.ListMembersPagedResponse listMembers(ListMembersRequest request)

Developer Preview: List members.

This API supports the fields parameter in SystemParameterContext. When the fields parameter is omitted this API response will default to "name,email,role,user".

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   ListMembersRequest request =
       ListMembersRequest.newBuilder()
           .setParent(SpaceName.of("[SPACE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Member element : spacesServiceClient.listMembers(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListMembersRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
SpacesServiceClient.ListMembersPagedResponse

listMembers(SpaceName parent)

public final SpacesServiceClient.ListMembersPagedResponse listMembers(SpaceName parent)

Developer Preview: List members.

This API supports the fields parameter in SystemParameterContext. When the fields parameter is omitted this API response will default to "name,email,role,user".

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   SpaceName parent = SpaceName.of("[SPACE]");
   for (Member element : spacesServiceClient.listMembers(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent SpaceName

Required. Format: spaces/{space}
Returns
Type Description
SpacesServiceClient.ListMembersPagedResponse

listMembers(String parent)

public final SpacesServiceClient.ListMembersPagedResponse listMembers(String parent)

Developer Preview: List members.

This API supports the fields parameter in SystemParameterContext. When the fields parameter is omitted this API response will default to "name,email,role,user".

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   String parent = SpaceName.of("[SPACE]").toString();
   for (Member element : spacesServiceClient.listMembers(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. Format: spaces/{space}
Returns
Type Description
SpacesServiceClient.ListMembersPagedResponse

listMembersCallable()

public final UnaryCallable<ListMembersRequest,ListMembersResponse> listMembersCallable()

Developer Preview: List members.

This API supports the fields parameter in SystemParameterContext. When the fields parameter is omitted this API response will default to "name,email,role,user".

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   ListMembersRequest request =
       ListMembersRequest.newBuilder()
           .setParent(SpaceName.of("[SPACE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListMembersResponse response = spacesServiceClient.listMembersCallable().call(request);
     for (Member element : response.getMembersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListMembersRequest,ListMembersResponse>

listMembersPagedCallable()

public final UnaryCallable<ListMembersRequest,SpacesServiceClient.ListMembersPagedResponse> listMembersPagedCallable()

Developer Preview: List members.

This API supports the fields parameter in SystemParameterContext. When the fields parameter is omitted this API response will default to "name,email,role,user".

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   ListMembersRequest request =
       ListMembersRequest.newBuilder()
           .setParent(SpaceName.of("[SPACE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Member> future = spacesServiceClient.listMembersPagedCallable().futureCall(request);
   // Do something.
   for (Member element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListMembersRequest,ListMembersPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateSpace(Space space, FieldMask updateMask)

public final Space updateSpace(Space space, FieldMask updateMask)

Updates details about a meeting space.

For an example, see Update a meeting space.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   Space space = Space.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Space response = spacesServiceClient.updateSpace(space, updateMask);
 }
Parameters
Name Description
space Space

Required. Space to be updated.
updateMask FieldMask

Optional. Field mask used to specify the fields to be updated in the space. If update_mask isn't provided(not set, set with empty paths, or only has "" as paths), it defaults to update all fields provided with values in the request. Using "*" as update_mask will update all fields, including deleting fields not set in the request.
Returns
Type Description
Space

updateSpace(UpdateSpaceRequest request)

public final Space updateSpace(UpdateSpaceRequest request)

Updates details about a meeting space.

For an example, see Update a meeting space.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   UpdateSpaceRequest request =
       UpdateSpaceRequest.newBuilder()
           .setSpace(Space.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Space response = spacesServiceClient.updateSpace(request);
 }
Parameter
Name Description
request UpdateSpaceRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Space

updateSpaceCallable()

public final UnaryCallable<UpdateSpaceRequest,Space> updateSpaceCallable()

Updates details about a meeting space.

For an example, see Update a meeting space.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SpacesServiceClient spacesServiceClient = SpacesServiceClient.create()) {
   UpdateSpaceRequest request =
       UpdateSpaceRequest.newBuilder()
           .setSpace(Space.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Space> future = spacesServiceClient.updateSpaceCallable().futureCall(request);
   // Do something.
   Space response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateSpaceRequest,Space>