Class SpacesServiceClient
- All Implemented Interfaces:
BackgroundResource,AutoCloseable
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().
| 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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetSpace |
Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateSpace |
Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ConnectActiveConference |
[Developer Preview](https://developers.google.com/workspace/preview): Broker a WebRTC connection to the active conference of a space. On success, clients must use the resulting SDP (Session Description Protocol) answer to establish a WebRTC connection. Once connected, additional functionality is available across WebRTC data channels. See [Meet Media API overview](https://developers.google.com/meet/media-api/guides/overview) for more details about this connection. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
EndActiveConference |
Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateMember |
[Developer Preview](https://developers.google.com/workspace/preview): Create a member. This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). 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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetMember |
[Developer Preview](https://developers.google.com/workspace/preview): Get a member. This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). 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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListMembers |
[Developer Preview](https://developers.google.com/workspace/preview): List members. This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). 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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteMember |
[Developer Preview](https://developers.google.com/workspace/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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic class -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedSpacesServiceClient(SpacesServiceSettings settings) Constructs an instance of SpacesServiceClient, using the given settings.protected -
Method Summary
Modifier and TypeMethodDescriptionbooleanawaitTermination(long duration, TimeUnit unit) final voidclose()[Developer Preview](https://developers.google.com/workspace/preview): Broker a WebRTC connection to the active conference of a space.[Developer Preview](https://developers.google.com/workspace/preview): Broker a WebRTC connection to the active conference of a space.[Developer Preview](https://developers.google.com/workspace/preview): Broker a WebRTC connection to the active conference of a space.[Developer Preview](https://developers.google.com/workspace/preview): Broker a WebRTC connection to the active conference of a space.static final SpacesServiceClientcreate()Constructs an instance of SpacesServiceClient with default settings.static final SpacesServiceClientcreate(SpacesServiceSettings settings) Constructs an instance of SpacesServiceClient, using the given settings.static final SpacesServiceClientcreate(SpacesServiceStub stub) Constructs an instance of SpacesServiceClient, using the given stub for making calls.final MembercreateMember(CreateMemberRequest request) [Developer Preview](https://developers.google.com/workspace/preview): Create a member.final MembercreateMember(SpaceName parent, Member member) [Developer Preview](https://developers.google.com/workspace/preview): Create a member.final MembercreateMember(String parent, Member member) [Developer Preview](https://developers.google.com/workspace/preview): Create a member.[Developer Preview](https://developers.google.com/workspace/preview): Create a member.final SpacecreateSpace(CreateSpaceRequest request) Creates a space.final SpacecreateSpace(Space space) Creates a space.final UnaryCallable<CreateSpaceRequest,Space> Creates a space.final voiddeleteMember(DeleteMemberRequest request) [Developer Preview](https://developers.google.com/workspace/preview): Delete the member who was previously assigned roles in the space.final voiddeleteMember(MemberName name) [Developer Preview](https://developers.google.com/workspace/preview): Delete the member who was previously assigned roles in the space.final voiddeleteMember(String name) [Developer Preview](https://developers.google.com/workspace/preview): Delete the member who was previously assigned roles in the space.final UnaryCallable<DeleteMemberRequest,com.google.protobuf.Empty> [Developer Preview](https://developers.google.com/workspace/preview): Delete the member who was previously assigned roles in the space.final voidEnds an active conference (if there's one).final voidendActiveConference(SpaceName name) Ends an active conference (if there's one).final voidendActiveConference(String name) Ends an active conference (if there's one).final UnaryCallable<EndActiveConferenceRequest,com.google.protobuf.Empty> Ends an active conference (if there's one).final MembergetMember(GetMemberRequest request) [Developer Preview](https://developers.google.com/workspace/preview): Get a member.final MembergetMember(MemberName name) [Developer Preview](https://developers.google.com/workspace/preview): Get a member.final Member[Developer Preview](https://developers.google.com/workspace/preview): Get a member.final UnaryCallable<GetMemberRequest,Member> [Developer Preview](https://developers.google.com/workspace/preview): Get a member.final SpacesServiceSettingsfinal SpacegetSpace(GetSpaceRequest request) Gets details about a meeting space.final SpaceGets details about a meeting space.final SpaceGets details about a meeting space.final UnaryCallable<GetSpaceRequest,Space> Gets details about a meeting space.getStub()booleanbooleanlistMembers(ListMembersRequest request) [Developer Preview](https://developers.google.com/workspace/preview): List members.listMembers(SpaceName parent) [Developer Preview](https://developers.google.com/workspace/preview): List members.listMembers(String parent) [Developer Preview](https://developers.google.com/workspace/preview): List members.[Developer Preview](https://developers.google.com/workspace/preview): List members.[Developer Preview](https://developers.google.com/workspace/preview): List members.voidshutdown()voidfinal SpaceupdateSpace(Space space, com.google.protobuf.FieldMask updateMask) Updates details about a meeting space.final SpaceupdateSpace(UpdateSpaceRequest request) Updates details about a meeting space.final UnaryCallable<UpdateSpaceRequest,Space> Updates details about a meeting space.
-
Constructor Details
-
SpacesServiceClient
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.- Throws:
IOException
-
SpacesServiceClient
-
-
Method Details
-
create
Constructs an instance of SpacesServiceClient with default settings.- Throws:
IOException
-
create
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.- Throws:
IOException
-
create
Constructs an instance of SpacesServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(SpacesServiceSettings). -
getSettings
-
getStub
-
createSpace
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); }- Parameters:
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.- Throws:
ApiException- if the remote call fails
-
createSpace
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
getSpace
Gets details about a meeting space.For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-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); }- Parameters:
name- 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](https://support.google.com/meet/answer/10710509).
For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).
- Throws:
ApiException- if the remote call fails
-
getSpace
Gets details about a meeting space.For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-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); }- Parameters:
name- 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](https://support.google.com/meet/answer/10710509).
For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).
- Throws:
ApiException- if the remote call fails
-
getSpace
Gets details about a meeting space.For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
getSpaceCallable
Gets details about a meeting space.For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-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(); } -
updateSpace
Updates details about a meeting space.For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-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:
space- Required. Space to be updated.updateMask- 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.- Throws:
ApiException- if the remote call fails
-
updateSpace
Updates details about a meeting space.For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
updateSpaceCallable
Updates details about a meeting space.For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-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(); } -
connectActiveConference
[Developer Preview](https://developers.google.com/workspace/preview): Broker a WebRTC connection to the active conference of a space.On success, clients must use the resulting SDP (Session Description Protocol) answer to establish a WebRTC connection. Once connected, additional functionality is available across WebRTC data channels.
See [Meet Media API overview](https://developers.google.com/meet/media-api/guides/overview) for more details about this connection.
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]"); ConnectActiveConferenceResponse response = spacesServiceClient.connectActiveConference(name); }- Parameters:
name- Required. Resource name of the space. Format: spaces/{spaceId}- Throws:
ApiException- if the remote call fails
-
connectActiveConference
[Developer Preview](https://developers.google.com/workspace/preview): Broker a WebRTC connection to the active conference of a space.On success, clients must use the resulting SDP (Session Description Protocol) answer to establish a WebRTC connection. Once connected, additional functionality is available across WebRTC data channels.
See [Meet Media API overview](https://developers.google.com/meet/media-api/guides/overview) for more details about this connection.
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(); ConnectActiveConferenceResponse response = spacesServiceClient.connectActiveConference(name); }- Parameters:
name- Required. Resource name of the space. Format: spaces/{spaceId}- Throws:
ApiException- if the remote call fails
-
connectActiveConference
public final ConnectActiveConferenceResponse connectActiveConference(ConnectActiveConferenceRequest request) [Developer Preview](https://developers.google.com/workspace/preview): Broker a WebRTC connection to the active conference of a space.On success, clients must use the resulting SDP (Session Description Protocol) answer to establish a WebRTC connection. Once connected, additional functionality is available across WebRTC data channels.
See [Meet Media API overview](https://developers.google.com/meet/media-api/guides/overview) for more details about this connection.
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()) { ConnectActiveConferenceRequest request = ConnectActiveConferenceRequest.newBuilder() .setName(SpaceName.of("[SPACE]").toString()) .setOffer("offer105650780") .build(); ConnectActiveConferenceResponse response = spacesServiceClient.connectActiveConference(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
connectActiveConferenceCallable
public final UnaryCallable<ConnectActiveConferenceRequest,ConnectActiveConferenceResponse> connectActiveConferenceCallable()[Developer Preview](https://developers.google.com/workspace/preview): Broker a WebRTC connection to the active conference of a space.On success, clients must use the resulting SDP (Session Description Protocol) answer to establish a WebRTC connection. Once connected, additional functionality is available across WebRTC data channels.
See [Meet Media API overview](https://developers.google.com/meet/media-api/guides/overview) for more details about this connection.
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()) { ConnectActiveConferenceRequest request = ConnectActiveConferenceRequest.newBuilder() .setName(SpaceName.of("[SPACE]").toString()) .setOffer("offer105650780") .build(); ApiFuture<ConnectActiveConferenceResponse> future = spacesServiceClient.connectActiveConferenceCallable().futureCall(request); // Do something. ConnectActiveConferenceResponse response = future.get(); } -
endActiveConference
Ends an active conference (if there's one).For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#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); }- Parameters:
name- 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](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).
- Throws:
ApiException- if the remote call fails
-
endActiveConference
Ends an active conference (if there's one).For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#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); }- Parameters:
name- 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](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).
- Throws:
ApiException- if the remote call fails
-
endActiveConference
Ends an active conference (if there's one).For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
endActiveConferenceCallable
public final UnaryCallable<EndActiveConferenceRequest,com.google.protobuf.Empty> endActiveConferenceCallable()Ends an active conference (if there's one).For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#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(); } -
createMember
[Developer Preview](https://developers.google.com/workspace/preview): Create a member.This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). 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:
parent- Required. Format: spaces/{space}member- Required. The member to be created.- Throws:
ApiException- if the remote call fails
-
createMember
[Developer Preview](https://developers.google.com/workspace/preview): Create a member.This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). 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:
parent- Required. Format: spaces/{space}member- Required. The member to be created.- Throws:
ApiException- if the remote call fails
-
createMember
[Developer Preview](https://developers.google.com/workspace/preview): Create a member.This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). 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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
createMemberCallable
[Developer Preview](https://developers.google.com/workspace/preview): Create a member.This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). 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(); } -
getMember
[Developer Preview](https://developers.google.com/workspace/preview): Get a member.This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). 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); }- Parameters:
name- Required. Format: “spaces/{space}/members/{member}”- Throws:
ApiException- if the remote call fails
-
getMember
[Developer Preview](https://developers.google.com/workspace/preview): Get a member.This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). 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); }- Parameters:
name- Required. Format: “spaces/{space}/members/{member}”- Throws:
ApiException- if the remote call fails
-
getMember
[Developer Preview](https://developers.google.com/workspace/preview): Get a member.This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). 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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
getMemberCallable
[Developer Preview](https://developers.google.com/workspace/preview): Get a member.This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). 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(); } -
listMembers
[Developer Preview](https://developers.google.com/workspace/preview): List members.This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). 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); } }- Parameters:
parent- Required. Format: spaces/{space}- Throws:
ApiException- if the remote call fails
-
listMembers
[Developer Preview](https://developers.google.com/workspace/preview): List members.This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). 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); } }- Parameters:
parent- Required. Format: spaces/{space}- Throws:
ApiException- if the remote call fails
-
listMembers
[Developer Preview](https://developers.google.com/workspace/preview): List members.This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). 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); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
listMembersPagedCallable
public final UnaryCallable<ListMembersRequest,SpacesServiceClient.ListMembersPagedResponse> listMembersPagedCallable()[Developer Preview](https://developers.google.com/workspace/preview): List members.This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). 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); } } -
listMembersCallable
[Developer Preview](https://developers.google.com/workspace/preview): List members.This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). 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; } } } -
deleteMember
[Developer Preview](https://developers.google.com/workspace/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); }- Parameters:
name- Required. Format: “spaces/{space}/members/{member}”- Throws:
ApiException- if the remote call fails
-
deleteMember
[Developer Preview](https://developers.google.com/workspace/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); }- Parameters:
name- Required. Format: “spaces/{space}/members/{member}”- Throws:
ApiException- if the remote call fails
-
deleteMember
[Developer Preview](https://developers.google.com/workspace/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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteMemberCallable
[Developer Preview](https://developers.google.com/workspace/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(); } -
close
public final void close()- Specified by:
closein interfaceAutoCloseable
-
shutdown
public void shutdown()- Specified by:
shutdownin interfaceBackgroundResource
-
isShutdown
public boolean isShutdown()- Specified by:
isShutdownin interfaceBackgroundResource
-
isTerminated
public boolean isTerminated()- Specified by:
isTerminatedin interfaceBackgroundResource
-
shutdownNow
public void shutdownNow()- Specified by:
shutdownNowin interfaceBackgroundResource
-
awaitTermination
- Specified by:
awaitTerminationin interfaceBackgroundResource- Throws:
InterruptedException
-