Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: [container] minor grammar improvements #9140

Merged
merged 6 commits into from
Feb 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions java-container/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,20 @@ If you are using Maven, add this to your pom.xml file:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-container</artifactId>
<version>2.12.0</version>
<version>2.14.0</version>
</dependency>
```

If you are using Gradle without BOM, add this to your dependencies:

```Groovy
implementation 'com.google.cloud:google-cloud-container:2.12.0'
implementation 'com.google.cloud:google-cloud-container:2.14.0'
```

If you are using SBT, add this to your dependencies:

```Scala
libraryDependencies += "com.google.cloud" % "google-cloud-container" % "2.12.0"
libraryDependencies += "com.google.cloud" % "google-cloud-container" % "2.14.0"
```

## Authentication
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1981,6 +1981,61 @@ public final UnaryCallable<GetServerConfigRequest, ServerConfig> getServerConfig
return stub.getServerConfigCallable();
}

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the public component of the cluster signing keys in JSON Web Key format. This API is not
* yet intended for general use, and is not available for all clusters.
*
* <p>Sample code:
*
* <pre>{@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 (ClusterManagerClient clusterManagerClient = ClusterManagerClient.create()) {
* GetJSONWebKeysRequest request =
* GetJSONWebKeysRequest.newBuilder().setParent("parent-995424086").build();
* GetJSONWebKeysResponse response = clusterManagerClient.getJSONWebKeys(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final GetJSONWebKeysResponse getJSONWebKeys(GetJSONWebKeysRequest request) {
return getJSONWebKeysCallable().call(request);
}

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the public component of the cluster signing keys in JSON Web Key format. This API is not
* yet intended for general use, and is not available for all clusters.
*
* <p>Sample code:
*
* <pre>{@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 (ClusterManagerClient clusterManagerClient = ClusterManagerClient.create()) {
* GetJSONWebKeysRequest request =
* GetJSONWebKeysRequest.newBuilder().setParent("parent-995424086").build();
* ApiFuture<GetJSONWebKeysResponse> future =
* clusterManagerClient.getJSONWebKeysCallable().futureCall(request);
* // Do something.
* GetJSONWebKeysResponse response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<GetJSONWebKeysRequest, GetJSONWebKeysResponse>
getJSONWebKeysCallable() {
return stub.getJSONWebKeysCallable();
}

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the node pools for a cluster.
Expand Down Expand Up @@ -2085,61 +2140,6 @@ public final UnaryCallable<ListNodePoolsRequest, ListNodePoolsResponse> listNode
return stub.listNodePoolsCallable();
}

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the public component of the cluster signing keys in JSON Web Key format. This API is not
* yet intended for general use, and is not available for all clusters.
*
* <p>Sample code:
*
* <pre>{@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 (ClusterManagerClient clusterManagerClient = ClusterManagerClient.create()) {
* GetJSONWebKeysRequest request =
* GetJSONWebKeysRequest.newBuilder().setParent("parent-995424086").build();
* GetJSONWebKeysResponse response = clusterManagerClient.getJSONWebKeys(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final GetJSONWebKeysResponse getJSONWebKeys(GetJSONWebKeysRequest request) {
return getJSONWebKeysCallable().call(request);
}

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the public component of the cluster signing keys in JSON Web Key format. This API is not
* yet intended for general use, and is not available for all clusters.
*
* <p>Sample code:
*
* <pre>{@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 (ClusterManagerClient clusterManagerClient = ClusterManagerClient.create()) {
* GetJSONWebKeysRequest request =
* GetJSONWebKeysRequest.newBuilder().setParent("parent-995424086").build();
* ApiFuture<GetJSONWebKeysResponse> future =
* clusterManagerClient.getJSONWebKeysCallable().futureCall(request);
* // Do something.
* GetJSONWebKeysResponse response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<GetJSONWebKeysRequest, GetJSONWebKeysResponse>
getJSONWebKeysCallable() {
return stub.getJSONWebKeysCallable();
}

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the requested node pool.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -211,16 +211,16 @@ public UnaryCallSettings<GetServerConfigRequest, ServerConfig> getServerConfigSe
return ((ClusterManagerStubSettings) getStubSettings()).getServerConfigSettings();
}

/** Returns the object with the settings used for calls to listNodePools. */
public UnaryCallSettings<ListNodePoolsRequest, ListNodePoolsResponse> listNodePoolsSettings() {
return ((ClusterManagerStubSettings) getStubSettings()).listNodePoolsSettings();
}

/** Returns the object with the settings used for calls to getJSONWebKeys. */
public UnaryCallSettings<GetJSONWebKeysRequest, GetJSONWebKeysResponse> getJSONWebKeysSettings() {
return ((ClusterManagerStubSettings) getStubSettings()).getJSONWebKeysSettings();
}

/** Returns the object with the settings used for calls to listNodePools. */
public UnaryCallSettings<ListNodePoolsRequest, ListNodePoolsResponse> listNodePoolsSettings() {
return ((ClusterManagerStubSettings) getStubSettings()).listNodePoolsSettings();
}

/** Returns the object with the settings used for calls to getNodePool. */
public UnaryCallSettings<GetNodePoolRequest, NodePool> getNodePoolSettings() {
return ((ClusterManagerStubSettings) getStubSettings()).getNodePoolSettings();
Expand Down Expand Up @@ -496,18 +496,18 @@ public UnaryCallSettings.Builder<CancelOperationRequest, Empty> cancelOperationS
return getStubSettingsBuilder().getServerConfigSettings();
}

/** Returns the builder for the settings used for calls to listNodePools. */
public UnaryCallSettings.Builder<ListNodePoolsRequest, ListNodePoolsResponse>
listNodePoolsSettings() {
return getStubSettingsBuilder().listNodePoolsSettings();
}

/** Returns the builder for the settings used for calls to getJSONWebKeys. */
public UnaryCallSettings.Builder<GetJSONWebKeysRequest, GetJSONWebKeysResponse>
getJSONWebKeysSettings() {
return getStubSettingsBuilder().getJSONWebKeysSettings();
}

/** Returns the builder for the settings used for calls to listNodePools. */
public UnaryCallSettings.Builder<ListNodePoolsRequest, ListNodePoolsResponse>
listNodePoolsSettings() {
return getStubSettingsBuilder().listNodePoolsSettings();
}

/** Returns the builder for the settings used for calls to getNodePool. */
public UnaryCallSettings.Builder<GetNodePoolRequest, NodePool> getNodePoolSettings() {
return getStubSettingsBuilder().getNodePoolSettings();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,14 +147,14 @@ public UnaryCallable<GetServerConfigRequest, ServerConfig> getServerConfigCallab
throw new UnsupportedOperationException("Not implemented: getServerConfigCallable()");
}

public UnaryCallable<ListNodePoolsRequest, ListNodePoolsResponse> listNodePoolsCallable() {
throw new UnsupportedOperationException("Not implemented: listNodePoolsCallable()");
}

public UnaryCallable<GetJSONWebKeysRequest, GetJSONWebKeysResponse> getJSONWebKeysCallable() {
throw new UnsupportedOperationException("Not implemented: getJSONWebKeysCallable()");
}

public UnaryCallable<ListNodePoolsRequest, ListNodePoolsResponse> listNodePoolsCallable() {
throw new UnsupportedOperationException("Not implemented: listNodePoolsCallable()");
}

public UnaryCallable<GetNodePoolRequest, NodePool> getNodePoolCallable() {
throw new UnsupportedOperationException("Not implemented: getNodePoolCallable()");
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -159,10 +159,10 @@ public class ClusterManagerStubSettings extends StubSettings<ClusterManagerStubS
private final UnaryCallSettings<GetOperationRequest, Operation> getOperationSettings;
private final UnaryCallSettings<CancelOperationRequest, Empty> cancelOperationSettings;
private final UnaryCallSettings<GetServerConfigRequest, ServerConfig> getServerConfigSettings;
private final UnaryCallSettings<ListNodePoolsRequest, ListNodePoolsResponse>
listNodePoolsSettings;
private final UnaryCallSettings<GetJSONWebKeysRequest, GetJSONWebKeysResponse>
getJSONWebKeysSettings;
private final UnaryCallSettings<ListNodePoolsRequest, ListNodePoolsResponse>
listNodePoolsSettings;
private final UnaryCallSettings<GetNodePoolRequest, NodePool> getNodePoolSettings;
private final UnaryCallSettings<CreateNodePoolRequest, Operation> createNodePoolSettings;
private final UnaryCallSettings<DeleteNodePoolRequest, Operation> deleteNodePoolSettings;
Expand Down Expand Up @@ -344,16 +344,16 @@ public UnaryCallSettings<GetServerConfigRequest, ServerConfig> getServerConfigSe
return getServerConfigSettings;
}

/** Returns the object with the settings used for calls to listNodePools. */
public UnaryCallSettings<ListNodePoolsRequest, ListNodePoolsResponse> listNodePoolsSettings() {
return listNodePoolsSettings;
}

/** Returns the object with the settings used for calls to getJSONWebKeys. */
public UnaryCallSettings<GetJSONWebKeysRequest, GetJSONWebKeysResponse> getJSONWebKeysSettings() {
return getJSONWebKeysSettings;
}

/** Returns the object with the settings used for calls to listNodePools. */
public UnaryCallSettings<ListNodePoolsRequest, ListNodePoolsResponse> listNodePoolsSettings() {
return listNodePoolsSettings;
}

/** Returns the object with the settings used for calls to getNodePool. */
public UnaryCallSettings<GetNodePoolRequest, NodePool> getNodePoolSettings() {
return getNodePoolSettings;
Expand Down Expand Up @@ -528,8 +528,8 @@ protected ClusterManagerStubSettings(Builder settingsBuilder) throws IOException
getOperationSettings = settingsBuilder.getOperationSettings().build();
cancelOperationSettings = settingsBuilder.cancelOperationSettings().build();
getServerConfigSettings = settingsBuilder.getServerConfigSettings().build();
listNodePoolsSettings = settingsBuilder.listNodePoolsSettings().build();
getJSONWebKeysSettings = settingsBuilder.getJSONWebKeysSettings().build();
listNodePoolsSettings = settingsBuilder.listNodePoolsSettings().build();
getNodePoolSettings = settingsBuilder.getNodePoolSettings().build();
createNodePoolSettings = settingsBuilder.createNodePoolSettings().build();
deleteNodePoolSettings = settingsBuilder.deleteNodePoolSettings().build();
Expand Down Expand Up @@ -575,10 +575,10 @@ public static class Builder extends StubSettings.Builder<ClusterManagerStubSetti
private final UnaryCallSettings.Builder<CancelOperationRequest, Empty> cancelOperationSettings;
private final UnaryCallSettings.Builder<GetServerConfigRequest, ServerConfig>
getServerConfigSettings;
private final UnaryCallSettings.Builder<ListNodePoolsRequest, ListNodePoolsResponse>
listNodePoolsSettings;
private final UnaryCallSettings.Builder<GetJSONWebKeysRequest, GetJSONWebKeysResponse>
getJSONWebKeysSettings;
private final UnaryCallSettings.Builder<ListNodePoolsRequest, ListNodePoolsResponse>
listNodePoolsSettings;
private final UnaryCallSettings.Builder<GetNodePoolRequest, NodePool> getNodePoolSettings;
private final UnaryCallSettings.Builder<CreateNodePoolRequest, Operation>
createNodePoolSettings;
Expand Down Expand Up @@ -679,8 +679,8 @@ protected Builder(ClientContext clientContext) {
getOperationSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
cancelOperationSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
getServerConfigSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
listNodePoolsSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
getJSONWebKeysSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
listNodePoolsSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
getNodePoolSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
createNodePoolSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
deleteNodePoolSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
Expand Down Expand Up @@ -717,8 +717,8 @@ protected Builder(ClientContext clientContext) {
getOperationSettings,
cancelOperationSettings,
getServerConfigSettings,
listNodePoolsSettings,
getJSONWebKeysSettings,
listNodePoolsSettings,
getNodePoolSettings,
createNodePoolSettings,
deleteNodePoolSettings,
Expand Down Expand Up @@ -757,8 +757,8 @@ protected Builder(ClusterManagerStubSettings settings) {
getOperationSettings = settings.getOperationSettings.toBuilder();
cancelOperationSettings = settings.cancelOperationSettings.toBuilder();
getServerConfigSettings = settings.getServerConfigSettings.toBuilder();
listNodePoolsSettings = settings.listNodePoolsSettings.toBuilder();
getJSONWebKeysSettings = settings.getJSONWebKeysSettings.toBuilder();
listNodePoolsSettings = settings.listNodePoolsSettings.toBuilder();
getNodePoolSettings = settings.getNodePoolSettings.toBuilder();
createNodePoolSettings = settings.createNodePoolSettings.toBuilder();
deleteNodePoolSettings = settings.deleteNodePoolSettings.toBuilder();
Expand Down Expand Up @@ -794,8 +794,8 @@ protected Builder(ClusterManagerStubSettings settings) {
getOperationSettings,
cancelOperationSettings,
getServerConfigSettings,
listNodePoolsSettings,
getJSONWebKeysSettings,
listNodePoolsSettings,
getNodePoolSettings,
createNodePoolSettings,
deleteNodePoolSettings,
Expand Down Expand Up @@ -912,16 +912,16 @@ private static Builder initDefaults(Builder builder) {
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_0_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_0_params"));

builder
.listNodePoolsSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_0_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_0_params"));

builder
.getJSONWebKeysSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("no_retry_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("no_retry_params"));

builder
.listNodePoolsSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_0_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_0_params"));

builder
.getNodePoolSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_0_codes"))
Expand Down Expand Up @@ -1111,18 +1111,18 @@ public UnaryCallSettings.Builder<CancelOperationRequest, Empty> cancelOperationS
return getServerConfigSettings;
}

/** Returns the builder for the settings used for calls to listNodePools. */
public UnaryCallSettings.Builder<ListNodePoolsRequest, ListNodePoolsResponse>
listNodePoolsSettings() {
return listNodePoolsSettings;
}

/** Returns the builder for the settings used for calls to getJSONWebKeys. */
public UnaryCallSettings.Builder<GetJSONWebKeysRequest, GetJSONWebKeysResponse>
getJSONWebKeysSettings() {
return getJSONWebKeysSettings;
}

/** Returns the builder for the settings used for calls to listNodePools. */
public UnaryCallSettings.Builder<ListNodePoolsRequest, ListNodePoolsResponse>
listNodePoolsSettings() {
return listNodePoolsSettings;
}

/** Returns the builder for the settings used for calls to getNodePool. */
public UnaryCallSettings.Builder<GetNodePoolRequest, NodePool> getNodePoolSettings() {
return getNodePoolSettings;
Expand Down
Loading