SpacesServiceClient (Google Google Meet API 0.3.0 API)

java.lang.Object
- com.google.apps.meet.v2beta.SpacesServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class SpacesServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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	[Developer Preview](https://developers.google.com/workspace/preview). 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	[Developer Preview](https://developers.google.com/workspace/preview). Gets a space by `space_id` or `meeting_code`.	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	[Developer Preview](https://developers.google.com/workspace/preview). Updates a 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	[Developer Preview](https://developers.google.com/workspace/preview). Ends an active conference (if there is one).	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()

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.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SpacesServiceClient(SpacesServiceSettings settings)` Constructs an instance of SpacesServiceClient, using the given settings.
`protected`	`SpacesServiceClient(SpacesServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static SpacesServiceClient`	`create()` Constructs an instance of SpacesServiceClient with default settings.
`static SpacesServiceClient`	`create(SpacesServiceSettings settings)` Constructs an instance of SpacesServiceClient, using the given settings.
`static SpacesServiceClient`	`create(SpacesServiceStub stub)` Constructs an instance of SpacesServiceClient, using the given stub for making calls.
`Space`	`createSpace(CreateSpaceRequest request)` [Developer Preview](https://developers.google.com/workspace/preview).
`Space`	`createSpace(Space space)` [Developer Preview](https://developers.google.com/workspace/preview).
`com.google.api.gax.rpc.UnaryCallable<CreateSpaceRequest,Space>`	`createSpaceCallable()` [Developer Preview](https://developers.google.com/workspace/preview).
`void`	`endActiveConference(EndActiveConferenceRequest request)` [Developer Preview](https://developers.google.com/workspace/preview).
`void`	`endActiveConference(SpaceName name)` [Developer Preview](https://developers.google.com/workspace/preview).
`void`	`endActiveConference(String name)` [Developer Preview](https://developers.google.com/workspace/preview).
`com.google.api.gax.rpc.UnaryCallable<EndActiveConferenceRequest,com.google.protobuf.Empty>`	`endActiveConferenceCallable()` [Developer Preview](https://developers.google.com/workspace/preview).
`SpacesServiceSettings`	`getSettings()`
`Space`	`getSpace(GetSpaceRequest request)` [Developer Preview](https://developers.google.com/workspace/preview).
`Space`	`getSpace(SpaceName name)` [Developer Preview](https://developers.google.com/workspace/preview).
`Space`	`getSpace(String name)` [Developer Preview](https://developers.google.com/workspace/preview).
`com.google.api.gax.rpc.UnaryCallable<GetSpaceRequest,Space>`	`getSpaceCallable()` [Developer Preview](https://developers.google.com/workspace/preview).
`SpacesServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`void`	`shutdown()`
`void`	`shutdownNow()`
`Space`	`updateSpace(Space space, com.google.protobuf.FieldMask updateMask)` [Developer Preview](https://developers.google.com/workspace/preview).
`Space`	`updateSpace(UpdateSpaceRequest request)` [Developer Preview](https://developers.google.com/workspace/preview).
`com.google.api.gax.rpc.UnaryCallable<UpdateSpaceRequest,Space>`	`updateSpaceCallable()` [Developer Preview](https://developers.google.com/workspace/preview).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SpacesServiceClient
```
protected SpacesServiceClient(SpacesServiceSettings settings)
                       throws IOException
```
  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
```
protected SpacesServiceClient(SpacesServiceStub stub)
```

Method Detail

create

public static final SpacesServiceClient create()
                                        throws IOException

Constructs an instance of SpacesServiceClient with default settings.

Throws:: IOException

create
```
public static final SpacesServiceClient create(SpacesServiceSettings settings)
                                        throws IOException
```
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
```
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).

getSettings

public final SpacesServiceSettings getSettings()

getStub
```
public SpacesServiceStub getStub()
```

createSpace

public final Space createSpace(Space space)

[Developer Preview](https://developers.google.com/workspace/preview). 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:: com.google.api.gax.rpc.ApiException - if the remote call fails

createSpace

public final Space createSpace(CreateSpaceRequest request)

[Developer Preview](https://developers.google.com/workspace/preview). 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:: com.google.api.gax.rpc.ApiException - if the remote call fails

createSpaceCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateSpaceRequest,Space> createSpaceCallable()

[Developer Preview](https://developers.google.com/workspace/preview). 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

public final Space getSpace(SpaceName name)

[Developer Preview](https://developers.google.com/workspace/preview). Gets a space by `space_id` or `meeting_code`.

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.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getSpace

public final Space getSpace(String name)

[Developer Preview](https://developers.google.com/workspace/preview). Gets a space by `space_id` or `meeting_code`.

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.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getSpace

public final Space getSpace(GetSpaceRequest request)

[Developer Preview](https://developers.google.com/workspace/preview). Gets a space by `space_id` or `meeting_code`.

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:: com.google.api.gax.rpc.ApiException - if the remote call fails

getSpaceCallable

public final com.google.api.gax.rpc.UnaryCallable<GetSpaceRequest,Space> getSpaceCallable()

[Developer Preview](https://developers.google.com/workspace/preview). Gets a space by `space_id` or `meeting_code`.

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

public final Space updateSpace(Space space,
                               com.google.protobuf.FieldMask updateMask)

[Developer Preview](https://developers.google.com/workspace/preview). Updates 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();
   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, it defaults to '*' and updates all fields provided in the request, including deleting fields not set in the request.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateSpace

public final Space updateSpace(UpdateSpaceRequest request)

[Developer Preview](https://developers.google.com/workspace/preview). Updates 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()) {
   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:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateSpaceCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateSpaceRequest,Space> updateSpaceCallable()

[Developer Preview](https://developers.google.com/workspace/preview). Updates 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()) {
   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();
 }

endActiveConference

public final void endActiveConference(SpaceName name)

[Developer Preview](https://developers.google.com/workspace/preview). Ends an active conference (if there is one).

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.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

endActiveConference

public final void endActiveConference(String name)

[Developer Preview](https://developers.google.com/workspace/preview). Ends an active conference (if there is one).

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.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

endActiveConference

public final void endActiveConference(EndActiveConferenceRequest request)

[Developer Preview](https://developers.google.com/workspace/preview). Ends an active conference (if there is one).

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:: com.google.api.gax.rpc.ApiException - if the remote call fails

endActiveConferenceCallable

public final com.google.api.gax.rpc.UnaryCallable<EndActiveConferenceRequest,com.google.protobuf.Empty> endActiveConferenceCallable()

[Developer Preview](https://developers.google.com/workspace/preview). Ends an active conference (if there is one).

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();
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class SpacesServiceClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SpacesServiceClient

SpacesServiceClient

Method Detail

create

create

create

getSettings

getStub

createSpace

createSpace

createSpaceCallable

getSpace

getSpace

getSpace

getSpaceCallable

updateSpace

updateSpace

updateSpaceCallable

endActiveConference

endActiveConference

endActiveConference

endActiveConferenceCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination