GitHub Repository | Product Reference |
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().
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of 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.
Static Methods
create()
public static final LintingServiceClient create()
Constructs an instance of LintingServiceClient with default settings.
Returns | |
---|---|
Type | Description |
LintingServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(LintingServiceSettings settings)
public static final LintingServiceClient create(LintingServiceSettings 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.
Parameter | |
---|---|
Name | Description |
settings |
LintingServiceSettings |
Returns | |
---|---|
Type | Description |
LintingServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(LintingServiceStub stub)
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).
Parameter | |
---|---|
Name | Description |
stub |
LintingServiceStub |
Returns | |
---|---|
Type | Description |
LintingServiceClient |
Constructors
LintingServiceClient(LintingServiceSettings settings)
protected LintingServiceClient(LintingServiceSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
LintingServiceSettings |
LintingServiceClient(LintingServiceStub stub)
protected LintingServiceClient(LintingServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub |
LintingServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration |
long |
unit |
TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
close()
public final void close()
getLocation(GetLocationRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.cloud.location.Location |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getSettings()
public final LintingServiceSettings getSettings()
Returns | |
---|---|
Type | Description |
LintingServiceSettings |
getStub()
public LintingServiceStub getStub()
Returns | |
---|---|
Type | Description |
LintingServiceStub |
getStyleGuide(GetStyleGuideRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
GetStyleGuideRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
StyleGuide |
getStyleGuide(StyleGuideName name)
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);
}
Parameter | |
---|---|
Name | Description |
name |
StyleGuideName Required. The name of the spec to retrieve. Format:
|
Returns | |
---|---|
Type | Description |
StyleGuide |
getStyleGuide(String name)
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);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the spec to retrieve. Format:
|
Returns | |
---|---|
Type | Description |
StyleGuide |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetStyleGuideRequest,StyleGuide> |
getStyleGuideContents(GetStyleGuideContentsRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
GetStyleGuideContentsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
StyleGuideContents |
getStyleGuideContents(StyleGuideName name)
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);
}
Parameter | |
---|---|
Name | Description |
name |
StyleGuideName 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
|
Returns | |
---|---|
Type | Description |
StyleGuideContents |
getStyleGuideContents(String name)
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);
}
Parameter | |
---|---|
Name | Description |
name |
String 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
|
Returns | |
---|---|
Type | Description |
StyleGuideContents |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetStyleGuideContentsRequest,StyleGuideContents> |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
lintSpec(LintSpecRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
LintSpecRequest The request object containing all of the parameters for the API call. |
lintSpecCallable()
public final UnaryCallable<LintSpecRequest,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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<LintSpecRequest,Empty> |
listLocations(ListLocationsRequest request)
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);
}
}
Parameter | |
---|---|
Name | Description |
request |
com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
LintingServiceClient.ListLocationsPagedResponse |
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;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
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);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateStyleGuide(StyleGuide styleGuide, FieldMask updateMask)
public final StyleGuide updateStyleGuide(StyleGuide styleGuide, 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 | |
---|---|
Name | Description |
styleGuide |
StyleGuide Required. The Style guide resource to update. |
updateMask |
FieldMask Optional. The list of fields to update. |
Returns | |
---|---|
Type | Description |
StyleGuide |
updateStyleGuide(UpdateStyleGuideRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
UpdateStyleGuideRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
StyleGuide |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateStyleGuideRequest,StyleGuide> |