Class VmwareEngineSettings (0.16.0)

public class VmwareEngineSettings extends ClientSettings<VmwareEngineSettings>

Settings class to configure an instance of VmwareEngineClient.

The default instance has everything set to sensible defaults:

  • The default service address (vmwareengine.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getPrivateCloud to 30 seconds:


 // 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
 VmwareEngineSettings.Builder vmwareEngineSettingsBuilder = VmwareEngineSettings.newBuilder();
 vmwareEngineSettingsBuilder
     .getPrivateCloudSettings()
     .setRetrySettings(
         vmwareEngineSettingsBuilder
             .getPrivateCloudSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 VmwareEngineSettings vmwareEngineSettings = vmwareEngineSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > VmwareEngineSettings

Static Methods

create(VmwareEngineStubSettings stub)

public static final VmwareEngineSettings create(VmwareEngineStubSettings stub)
Parameter
NameDescription
stubVmwareEngineStubSettings
Returns
TypeDescription
VmwareEngineSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static VmwareEngineSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
VmwareEngineSettings.Builder

newBuilder(ClientContext clientContext)

public static VmwareEngineSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
VmwareEngineSettings.Builder

newHttpJsonBuilder()

public static VmwareEngineSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
VmwareEngineSettings.Builder

Constructors

VmwareEngineSettings(VmwareEngineSettings.Builder settingsBuilder)

protected VmwareEngineSettings(VmwareEngineSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderVmwareEngineSettings.Builder

Methods

createClusterOperationSettings()

public OperationCallSettings<CreateClusterRequest,Cluster,OperationMetadata> createClusterOperationSettings()

Returns the object with the settings used for calls to createCluster.

createClusterSettings()

public UnaryCallSettings<CreateClusterRequest,Operation> createClusterSettings()

Returns the object with the settings used for calls to createCluster.

createHcxActivationKeyOperationSettings()

public OperationCallSettings<CreateHcxActivationKeyRequest,HcxActivationKey,OperationMetadata> createHcxActivationKeyOperationSettings()

Returns the object with the settings used for calls to createHcxActivationKey.

createHcxActivationKeySettings()

public UnaryCallSettings<CreateHcxActivationKeyRequest,Operation> createHcxActivationKeySettings()

Returns the object with the settings used for calls to createHcxActivationKey.

createNetworkPolicyOperationSettings()

public OperationCallSettings<CreateNetworkPolicyRequest,NetworkPolicy,OperationMetadata> createNetworkPolicyOperationSettings()

Returns the object with the settings used for calls to createNetworkPolicy.

createNetworkPolicySettings()

public UnaryCallSettings<CreateNetworkPolicyRequest,Operation> createNetworkPolicySettings()

Returns the object with the settings used for calls to createNetworkPolicy.

createPrivateCloudOperationSettings()

public OperationCallSettings<CreatePrivateCloudRequest,PrivateCloud,OperationMetadata> createPrivateCloudOperationSettings()

Returns the object with the settings used for calls to createPrivateCloud.

createPrivateCloudSettings()

public UnaryCallSettings<CreatePrivateCloudRequest,Operation> createPrivateCloudSettings()

Returns the object with the settings used for calls to createPrivateCloud.

createPrivateConnectionOperationSettings()

public OperationCallSettings<CreatePrivateConnectionRequest,PrivateConnection,OperationMetadata> createPrivateConnectionOperationSettings()

Returns the object with the settings used for calls to createPrivateConnection.

createPrivateConnectionSettings()

public UnaryCallSettings<CreatePrivateConnectionRequest,Operation> createPrivateConnectionSettings()

Returns the object with the settings used for calls to createPrivateConnection.

createVmwareEngineNetworkOperationSettings()

public OperationCallSettings<CreateVmwareEngineNetworkRequest,VmwareEngineNetwork,OperationMetadata> createVmwareEngineNetworkOperationSettings()

Returns the object with the settings used for calls to createVmwareEngineNetwork.

createVmwareEngineNetworkSettings()

public UnaryCallSettings<CreateVmwareEngineNetworkRequest,Operation> createVmwareEngineNetworkSettings()

Returns the object with the settings used for calls to createVmwareEngineNetwork.

deleteClusterOperationSettings()

public OperationCallSettings<DeleteClusterRequest,Empty,OperationMetadata> deleteClusterOperationSettings()

Returns the object with the settings used for calls to deleteCluster.

deleteClusterSettings()

public UnaryCallSettings<DeleteClusterRequest,Operation> deleteClusterSettings()

Returns the object with the settings used for calls to deleteCluster.

deleteNetworkPolicyOperationSettings()

public OperationCallSettings<DeleteNetworkPolicyRequest,Empty,OperationMetadata> deleteNetworkPolicyOperationSettings()

Returns the object with the settings used for calls to deleteNetworkPolicy.

deleteNetworkPolicySettings()

public UnaryCallSettings<DeleteNetworkPolicyRequest,Operation> deleteNetworkPolicySettings()

Returns the object with the settings used for calls to deleteNetworkPolicy.

deletePrivateCloudOperationSettings()

public OperationCallSettings<DeletePrivateCloudRequest,PrivateCloud,OperationMetadata> deletePrivateCloudOperationSettings()

Returns the object with the settings used for calls to deletePrivateCloud.

deletePrivateCloudSettings()

public UnaryCallSettings<DeletePrivateCloudRequest,Operation> deletePrivateCloudSettings()

Returns the object with the settings used for calls to deletePrivateCloud.

deletePrivateConnectionOperationSettings()

public OperationCallSettings<DeletePrivateConnectionRequest,Empty,OperationMetadata> deletePrivateConnectionOperationSettings()

Returns the object with the settings used for calls to deletePrivateConnection.

deletePrivateConnectionSettings()

public UnaryCallSettings<DeletePrivateConnectionRequest,Operation> deletePrivateConnectionSettings()

Returns the object with the settings used for calls to deletePrivateConnection.

deleteVmwareEngineNetworkOperationSettings()

public OperationCallSettings<DeleteVmwareEngineNetworkRequest,Empty,OperationMetadata> deleteVmwareEngineNetworkOperationSettings()

Returns the object with the settings used for calls to deleteVmwareEngineNetwork.

deleteVmwareEngineNetworkSettings()

public UnaryCallSettings<DeleteVmwareEngineNetworkRequest,Operation> deleteVmwareEngineNetworkSettings()

Returns the object with the settings used for calls to deleteVmwareEngineNetwork.

getClusterSettings()

public UnaryCallSettings<GetClusterRequest,Cluster> getClusterSettings()

Returns the object with the settings used for calls to getCluster.

getHcxActivationKeySettings()

public UnaryCallSettings<GetHcxActivationKeyRequest,HcxActivationKey> getHcxActivationKeySettings()

Returns the object with the settings used for calls to getHcxActivationKey.

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

Returns the object with the settings used for calls to getIamPolicy.

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

Returns the object with the settings used for calls to getLocation.

Returns
TypeDescription
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getNetworkPolicySettings()

public UnaryCallSettings<GetNetworkPolicyRequest,NetworkPolicy> getNetworkPolicySettings()

Returns the object with the settings used for calls to getNetworkPolicy.

getNodeTypeSettings()

public UnaryCallSettings<GetNodeTypeRequest,NodeType> getNodeTypeSettings()

Returns the object with the settings used for calls to getNodeType.

getPrivateCloudSettings()

public UnaryCallSettings<GetPrivateCloudRequest,PrivateCloud> getPrivateCloudSettings()

Returns the object with the settings used for calls to getPrivateCloud.

getPrivateConnectionSettings()

public UnaryCallSettings<GetPrivateConnectionRequest,PrivateConnection> getPrivateConnectionSettings()

Returns the object with the settings used for calls to getPrivateConnection.

getSubnetSettings()

public UnaryCallSettings<GetSubnetRequest,Subnet> getSubnetSettings()

Returns the object with the settings used for calls to getSubnet.

getVmwareEngineNetworkSettings()

public UnaryCallSettings<GetVmwareEngineNetworkRequest,VmwareEngineNetwork> getVmwareEngineNetworkSettings()

Returns the object with the settings used for calls to getVmwareEngineNetwork.

listClustersSettings()

public PagedCallSettings<ListClustersRequest,ListClustersResponse,VmwareEngineClient.ListClustersPagedResponse> listClustersSettings()

Returns the object with the settings used for calls to listClusters.

listHcxActivationKeysSettings()

public PagedCallSettings<ListHcxActivationKeysRequest,ListHcxActivationKeysResponse,VmwareEngineClient.ListHcxActivationKeysPagedResponse> listHcxActivationKeysSettings()

Returns the object with the settings used for calls to listHcxActivationKeys.

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,VmwareEngineClient.ListLocationsPagedResponse> listLocationsSettings()

Returns the object with the settings used for calls to listLocations.

Returns
TypeDescription
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listNetworkPoliciesSettings()

public PagedCallSettings<ListNetworkPoliciesRequest,ListNetworkPoliciesResponse,VmwareEngineClient.ListNetworkPoliciesPagedResponse> listNetworkPoliciesSettings()

Returns the object with the settings used for calls to listNetworkPolicies.

listNodeTypesSettings()

public PagedCallSettings<ListNodeTypesRequest,ListNodeTypesResponse,VmwareEngineClient.ListNodeTypesPagedResponse> listNodeTypesSettings()

Returns the object with the settings used for calls to listNodeTypes.

listPrivateCloudsSettings()

public PagedCallSettings<ListPrivateCloudsRequest,ListPrivateCloudsResponse,VmwareEngineClient.ListPrivateCloudsPagedResponse> listPrivateCloudsSettings()

Returns the object with the settings used for calls to listPrivateClouds.

listPrivateConnectionPeeringRoutesSettings()

public PagedCallSettings<ListPrivateConnectionPeeringRoutesRequest,ListPrivateConnectionPeeringRoutesResponse,VmwareEngineClient.ListPrivateConnectionPeeringRoutesPagedResponse> listPrivateConnectionPeeringRoutesSettings()

Returns the object with the settings used for calls to listPrivateConnectionPeeringRoutes.

listPrivateConnectionsSettings()

public PagedCallSettings<ListPrivateConnectionsRequest,ListPrivateConnectionsResponse,VmwareEngineClient.ListPrivateConnectionsPagedResponse> listPrivateConnectionsSettings()

Returns the object with the settings used for calls to listPrivateConnections.

listSubnetsSettings()

public PagedCallSettings<ListSubnetsRequest,ListSubnetsResponse,VmwareEngineClient.ListSubnetsPagedResponse> listSubnetsSettings()

Returns the object with the settings used for calls to listSubnets.

listVmwareEngineNetworksSettings()

public PagedCallSettings<ListVmwareEngineNetworksRequest,ListVmwareEngineNetworksResponse,VmwareEngineClient.ListVmwareEngineNetworksPagedResponse> listVmwareEngineNetworksSettings()

Returns the object with the settings used for calls to listVmwareEngineNetworks.

resetNsxCredentialsOperationSettings()

public OperationCallSettings<ResetNsxCredentialsRequest,PrivateCloud,OperationMetadata> resetNsxCredentialsOperationSettings()

Returns the object with the settings used for calls to resetNsxCredentials.

resetNsxCredentialsSettings()

public UnaryCallSettings<ResetNsxCredentialsRequest,Operation> resetNsxCredentialsSettings()

Returns the object with the settings used for calls to resetNsxCredentials.

resetVcenterCredentialsOperationSettings()

public OperationCallSettings<ResetVcenterCredentialsRequest,PrivateCloud,OperationMetadata> resetVcenterCredentialsOperationSettings()

Returns the object with the settings used for calls to resetVcenterCredentials.

resetVcenterCredentialsSettings()

public UnaryCallSettings<ResetVcenterCredentialsRequest,Operation> resetVcenterCredentialsSettings()

Returns the object with the settings used for calls to resetVcenterCredentials.

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

Returns the object with the settings used for calls to setIamPolicy.

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

showNsxCredentialsSettings()

public UnaryCallSettings<ShowNsxCredentialsRequest,Credentials> showNsxCredentialsSettings()

Returns the object with the settings used for calls to showNsxCredentials.

showVcenterCredentialsSettings()

public UnaryCallSettings<ShowVcenterCredentialsRequest,Credentials> showVcenterCredentialsSettings()

Returns the object with the settings used for calls to showVcenterCredentials.

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

Returns the object with the settings used for calls to testIamPermissions.

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public VmwareEngineSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
TypeDescription
VmwareEngineSettings.Builder
Overrides

undeletePrivateCloudOperationSettings()

public OperationCallSettings<UndeletePrivateCloudRequest,PrivateCloud,OperationMetadata> undeletePrivateCloudOperationSettings()

Returns the object with the settings used for calls to undeletePrivateCloud.

undeletePrivateCloudSettings()

public UnaryCallSettings<UndeletePrivateCloudRequest,Operation> undeletePrivateCloudSettings()

Returns the object with the settings used for calls to undeletePrivateCloud.

updateClusterOperationSettings()

public OperationCallSettings<UpdateClusterRequest,Cluster,OperationMetadata> updateClusterOperationSettings()

Returns the object with the settings used for calls to updateCluster.

updateClusterSettings()

public UnaryCallSettings<UpdateClusterRequest,Operation> updateClusterSettings()

Returns the object with the settings used for calls to updateCluster.

updateNetworkPolicyOperationSettings()

public OperationCallSettings<UpdateNetworkPolicyRequest,NetworkPolicy,OperationMetadata> updateNetworkPolicyOperationSettings()

Returns the object with the settings used for calls to updateNetworkPolicy.

updateNetworkPolicySettings()

public UnaryCallSettings<UpdateNetworkPolicyRequest,Operation> updateNetworkPolicySettings()

Returns the object with the settings used for calls to updateNetworkPolicy.

updatePrivateCloudOperationSettings()

public OperationCallSettings<UpdatePrivateCloudRequest,PrivateCloud,OperationMetadata> updatePrivateCloudOperationSettings()

Returns the object with the settings used for calls to updatePrivateCloud.

updatePrivateCloudSettings()

public UnaryCallSettings<UpdatePrivateCloudRequest,Operation> updatePrivateCloudSettings()

Returns the object with the settings used for calls to updatePrivateCloud.

updatePrivateConnectionOperationSettings()

public OperationCallSettings<UpdatePrivateConnectionRequest,PrivateConnection,OperationMetadata> updatePrivateConnectionOperationSettings()

Returns the object with the settings used for calls to updatePrivateConnection.

updatePrivateConnectionSettings()

public UnaryCallSettings<UpdatePrivateConnectionRequest,Operation> updatePrivateConnectionSettings()

Returns the object with the settings used for calls to updatePrivateConnection.

updateSubnetOperationSettings()

public OperationCallSettings<UpdateSubnetRequest,Subnet,OperationMetadata> updateSubnetOperationSettings()

Returns the object with the settings used for calls to updateSubnet.

updateSubnetSettings()

public UnaryCallSettings<UpdateSubnetRequest,Operation> updateSubnetSettings()

Returns the object with the settings used for calls to updateSubnet.

updateVmwareEngineNetworkOperationSettings()

public OperationCallSettings<UpdateVmwareEngineNetworkRequest,VmwareEngineNetwork,OperationMetadata> updateVmwareEngineNetworkOperationSettings()

Returns the object with the settings used for calls to updateVmwareEngineNetwork.

updateVmwareEngineNetworkSettings()

public UnaryCallSettings<UpdateVmwareEngineNetworkRequest,Operation> updateVmwareEngineNetworkSettings()

Returns the object with the settings used for calls to updateVmwareEngineNetwork.