Package com.google.apps.meet.v2

Class SpacesServiceClient

java.lang.Object
com.google.apps.meet.v2.SpacesServiceClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class SpacesServiceClient extends Object implements 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

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](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.

  • 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](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.

  • 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](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.

  • 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 Details

    • 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 Details

    • 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)
      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

      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);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

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

    • getSpace

      public final Space getSpace(SpaceName name)
      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

      public final Space getSpace(String name)
      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

      public final Space getSpace(GetSpaceRequest request)
      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

      public final UnaryCallable<GetSpaceRequest,Space> 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

      public final Space updateSpace(Space space, com.google.protobuf.FieldMask updateMask)
      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

      public final Space updateSpace(UpdateSpaceRequest request)
      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

      public final UnaryCallable<UpdateSpaceRequest,Space> 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();
 }

    • endActiveConference

      public final void endActiveConference(SpaceName name)
      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

      public final void endActiveConference(String name)
      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

      public final void endActiveConference(EndActiveConferenceRequest request)
      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();
 }

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException