Package com.google.cloud.apihub.v1

Class LintingServiceClient

java.lang.Object
com.google.cloud.apihub.v1.LintingServiceClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class LintingServiceClient extends Object implements BackgroundResource
Service Description: This service provides all methods related to the 1p Linter.

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 (LintingServiceClient lintingServiceClient = LintingServiceClient.create()) {
   StyleGuideName name = StyleGuideName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]");
   StyleGuide response = lintingServiceClient.getStyleGuide(name);
 }

Note: close() needs to be called on the LintingServiceClient 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

GetStyleGuide

Get the style guide being used for linting.

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

  • getStyleGuide(GetStyleGuideRequest request)

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

  • getStyleGuide(StyleGuideName name)

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

  • getStyleGuideCallable()

UpdateStyleGuide

Update the styleGuide to be used for liniting in by API hub.

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

  • updateStyleGuide(UpdateStyleGuideRequest request)

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

  • updateStyleGuide(StyleGuide styleGuide, 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.

  • updateStyleGuideCallable()

GetStyleGuideContents

Get the contents of the style guide.

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

  • getStyleGuideContents(GetStyleGuideContentsRequest request)

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

  • getStyleGuideContents(StyleGuideName name)

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

  • getStyleGuideContentsCallable()

LintSpec

Lints the requested spec and updates the corresponding API Spec with the lint response. This lint response will be available in all subsequent Get and List Spec calls to Core service.

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

  • lintSpec(LintSpecRequest request)

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

  • lintSpecCallable()

ListLocations

Lists information about the supported locations for this service.

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

  • listLocations(ListLocationsRequest request)

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

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

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

  • getLocation(GetLocationRequest request)

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

  • getLocationCallable()

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 LintingServiceSettings 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
 LintingServiceSettings lintingServiceSettings =
     LintingServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 LintingServiceClient lintingServiceClient = LintingServiceClient.create(lintingServiceSettings);

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
 LintingServiceSettings lintingServiceSettings =
     LintingServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 LintingServiceClient lintingServiceClient = LintingServiceClient.create(lintingServiceSettings);

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

  • Constructor Details

    • LintingServiceClient

      protected LintingServiceClient(LintingServiceSettings settings) throws IOException
      Constructs an instance of LintingServiceClient, 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

    • LintingServiceClient

      protected LintingServiceClient(LintingServiceStub stub)

  • Method Details

    • create

      public static final LintingServiceClient create() throws IOException
      Constructs an instance of LintingServiceClient with default settings.
      Throws:
      IOException

    • create

      public static final LintingServiceClient create(LintingServiceSettings settings) throws IOException
      Constructs an instance of LintingServiceClient, 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 LintingServiceClient create(LintingServiceStub stub)
      Constructs an instance of LintingServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(LintingServiceSettings).

    • getSettings

      public final LintingServiceSettings getSettings()

    • getStub

      public LintingServiceStub getStub()

    • getStyleGuide

      public final StyleGuide getStyleGuide(StyleGuideName name)
      Get the style guide being used for linting.

      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 (LintingServiceClient lintingServiceClient = LintingServiceClient.create()) {
   StyleGuideName name = StyleGuideName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]");
   StyleGuide response = lintingServiceClient.getStyleGuide(name);
 }
      Parameters:
      name - Required. The name of the spec to retrieve. Format: `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`.
      Throws:
      ApiException - if the remote call fails

    • getStyleGuide

      public final StyleGuide getStyleGuide(String name)
      Get the style guide being used for linting.

      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 (LintingServiceClient lintingServiceClient = LintingServiceClient.create()) {
   String name = StyleGuideName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString();
   StyleGuide response = lintingServiceClient.getStyleGuide(name);
 }
      Parameters:
      name - Required. The name of the spec to retrieve. Format: `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`.
      Throws:
      ApiException - if the remote call fails

    • getStyleGuide

      public final StyleGuide getStyleGuide(GetStyleGuideRequest request)
      Get the style guide being used for linting.

      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 (LintingServiceClient lintingServiceClient = LintingServiceClient.create()) {
   GetStyleGuideRequest request =
       GetStyleGuideRequest.newBuilder()
           .setName(StyleGuideName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
           .build();
   StyleGuide response = lintingServiceClient.getStyleGuide(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getStyleGuideCallable

      public final UnaryCallable<GetStyleGuideRequest,StyleGuide> getStyleGuideCallable()
      Get the style guide being used for linting.

      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 (LintingServiceClient lintingServiceClient = LintingServiceClient.create()) {
   GetStyleGuideRequest request =
       GetStyleGuideRequest.newBuilder()
           .setName(StyleGuideName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
           .build();
   ApiFuture<StyleGuide> future =
       lintingServiceClient.getStyleGuideCallable().futureCall(request);
   // Do something.
   StyleGuide response = future.get();
 }

    • updateStyleGuide

      public final StyleGuide updateStyleGuide(StyleGuide styleGuide, com.google.protobuf.FieldMask updateMask)
      Update the styleGuide to be used for liniting in by API hub.

      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 (LintingServiceClient lintingServiceClient = LintingServiceClient.create()) {
   StyleGuide styleGuide = StyleGuide.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   StyleGuide response = lintingServiceClient.updateStyleGuide(styleGuide, updateMask);
 }
      Parameters:
      styleGuide - Required. The Style guide resource to update.
      updateMask - Optional. The list of fields to update.
      Throws:
      ApiException - if the remote call fails

    • updateStyleGuide

      public final StyleGuide updateStyleGuide(UpdateStyleGuideRequest request)
      Update the styleGuide to be used for liniting in by API hub.

      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 (LintingServiceClient lintingServiceClient = LintingServiceClient.create()) {
   UpdateStyleGuideRequest request =
       UpdateStyleGuideRequest.newBuilder()
           .setStyleGuide(StyleGuide.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   StyleGuide response = lintingServiceClient.updateStyleGuide(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • updateStyleGuideCallable

      public final UnaryCallable<UpdateStyleGuideRequest,StyleGuide> updateStyleGuideCallable()
      Update the styleGuide to be used for liniting in by API hub.

      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 (LintingServiceClient lintingServiceClient = LintingServiceClient.create()) {
   UpdateStyleGuideRequest request =
       UpdateStyleGuideRequest.newBuilder()
           .setStyleGuide(StyleGuide.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<StyleGuide> future =
       lintingServiceClient.updateStyleGuideCallable().futureCall(request);
   // Do something.
   StyleGuide response = future.get();
 }

    • getStyleGuideContents

      public final StyleGuideContents getStyleGuideContents(StyleGuideName name)
      Get the contents of the style guide.

      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 (LintingServiceClient lintingServiceClient = LintingServiceClient.create()) {
   StyleGuideName name = StyleGuideName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]");
   StyleGuideContents response = lintingServiceClient.getStyleGuideContents(name);
 }
      Parameters:
      name - Required. The name of the StyleGuide whose contents need to be retrieved. There is exactly one style guide resource per project per location. The expected format is `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`.
      Throws:
      ApiException - if the remote call fails

    • getStyleGuideContents

      public final StyleGuideContents getStyleGuideContents(String name)
      Get the contents of the style guide.

      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 (LintingServiceClient lintingServiceClient = LintingServiceClient.create()) {
   String name = StyleGuideName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString();
   StyleGuideContents response = lintingServiceClient.getStyleGuideContents(name);
 }
      Parameters:
      name - Required. The name of the StyleGuide whose contents need to be retrieved. There is exactly one style guide resource per project per location. The expected format is `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`.
      Throws:
      ApiException - if the remote call fails

    • getStyleGuideContents

      public final StyleGuideContents getStyleGuideContents(GetStyleGuideContentsRequest request)
      Get the contents of the style guide.

      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 (LintingServiceClient lintingServiceClient = LintingServiceClient.create()) {
   GetStyleGuideContentsRequest request =
       GetStyleGuideContentsRequest.newBuilder()
           .setName(StyleGuideName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
           .build();
   StyleGuideContents response = lintingServiceClient.getStyleGuideContents(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getStyleGuideContentsCallable

      public final UnaryCallable<GetStyleGuideContentsRequest,StyleGuideContents> getStyleGuideContentsCallable()
      Get the contents of the style guide.

      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 (LintingServiceClient lintingServiceClient = LintingServiceClient.create()) {
   GetStyleGuideContentsRequest request =
       GetStyleGuideContentsRequest.newBuilder()
           .setName(StyleGuideName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
           .build();
   ApiFuture<StyleGuideContents> future =
       lintingServiceClient.getStyleGuideContentsCallable().futureCall(request);
   // Do something.
   StyleGuideContents response = future.get();
 }

    • lintSpec

      public final void lintSpec(LintSpecRequest request)
      Lints the requested spec and updates the corresponding API Spec with the lint response. This lint response will be available in all subsequent Get and List Spec calls to Core service.

      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 (LintingServiceClient lintingServiceClient = LintingServiceClient.create()) {
   LintSpecRequest request =
       LintSpecRequest.newBuilder()
           .setName(
               SpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]").toString())
           .build();
   lintingServiceClient.lintSpec(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • lintSpecCallable

      public final UnaryCallable<LintSpecRequest,com.google.protobuf.Empty> lintSpecCallable()
      Lints the requested spec and updates the corresponding API Spec with the lint response. This lint response will be available in all subsequent Get and List Spec calls to Core service.

      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 (LintingServiceClient lintingServiceClient = LintingServiceClient.create()) {
   LintSpecRequest request =
       LintSpecRequest.newBuilder()
           .setName(
               SpecName.of("[PROJECT]", "[LOCATION]", "[API]", "[VERSION]", "[SPEC]").toString())
           .build();
   ApiFuture<Empty> future = lintingServiceClient.lintSpecCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • listLocations

      public final LintingServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)
      Lists information about the supported locations for this service.

      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 (LintingServiceClient lintingServiceClient = LintingServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : lintingServiceClient.listLocations(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

    • listLocationsPagedCallable

      public final UnaryCallable<ListLocationsRequest,LintingServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()
      Lists information about the supported locations for this service.

      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 (LintingServiceClient lintingServiceClient = LintingServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       lintingServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listLocationsCallable

      public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
      Lists information about the supported locations for this service.

      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 (LintingServiceClient lintingServiceClient = LintingServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = lintingServiceClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • getLocation

      public final Location getLocation(GetLocationRequest request)
      Gets information about a location.

      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 (LintingServiceClient lintingServiceClient = LintingServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = lintingServiceClient.getLocation(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getLocationCallable

      public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
      Gets information about a location.

      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 (LintingServiceClient lintingServiceClient = LintingServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = lintingServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = 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