Class LintingServiceClient (0.2.0)

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

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

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

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

Constructs an instance of LintingServiceClient with default settings.

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.

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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