Class VmwareEngineSettings (0.6.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

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(VmwareEngineStubSettings stub)

public static final VmwareEngineSettings create(VmwareEngineStubSettings stub)

Parameter

Name	Description
`stub`	`VmwareEngineStubSettings`

Returns

Type	Description
`VmwareEngineSettings`

Exceptions

Type	Description
`IOException`

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns

Type	Description
`Builder`

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns

Type	Description
`Builder`

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns

Type	Description
`Builder`

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns

Type	Description
`Builder`

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns

Type	Description
`Builder`

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns

Type	Description
`TransportChannelProvider`

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns

Type	Description
`String`

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
`List<String>`

newBuilder()

public static VmwareEngineSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns

Type	Description
`VmwareEngineSettings.Builder`

newBuilder(ClientContext clientContext)

public static VmwareEngineSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
`clientContext`	`ClientContext`

Returns

Type	Description
`VmwareEngineSettings.Builder`

newHttpJsonBuilder()

public static VmwareEngineSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns

Type	Description
`VmwareEngineSettings.Builder`

Constructors

VmwareEngineSettings(VmwareEngineSettings.Builder settingsBuilder)

protected VmwareEngineSettings(VmwareEngineSettings.Builder settingsBuilder)

Parameter

Name	Description
`settingsBuilder`	`VmwareEngineSettings.Builder`

Methods

createClusterOperationSettings()

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

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

Returns

Type	Description
`OperationCallSettings<CreateClusterRequest,Cluster,OperationMetadata>`

createClusterSettings()

public UnaryCallSettings<CreateClusterRequest,Operation> createClusterSettings()

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

Returns

Type	Description
`UnaryCallSettings<CreateClusterRequest,Operation>`

createHcxActivationKeyOperationSettings()

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

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

Returns

Type	Description
`OperationCallSettings<CreateHcxActivationKeyRequest,HcxActivationKey,OperationMetadata>`

createHcxActivationKeySettings()

public UnaryCallSettings<CreateHcxActivationKeyRequest,Operation> createHcxActivationKeySettings()

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

Returns

Type	Description
`UnaryCallSettings<CreateHcxActivationKeyRequest,Operation>`

createNetworkPolicyOperationSettings()

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

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

Returns

Type	Description
`OperationCallSettings<CreateNetworkPolicyRequest,NetworkPolicy,OperationMetadata>`

createNetworkPolicySettings()

public UnaryCallSettings<CreateNetworkPolicyRequest,Operation> createNetworkPolicySettings()

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

Returns

Type	Description
`UnaryCallSettings<CreateNetworkPolicyRequest,Operation>`

createPrivateCloudOperationSettings()

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

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

Returns

Type	Description
`OperationCallSettings<CreatePrivateCloudRequest,PrivateCloud,OperationMetadata>`

createPrivateCloudSettings()

public UnaryCallSettings<CreatePrivateCloudRequest,Operation> createPrivateCloudSettings()

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

Returns

Type	Description
`UnaryCallSettings<CreatePrivateCloudRequest,Operation>`

createVmwareEngineNetworkOperationSettings()

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

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

Returns

Type	Description
`OperationCallSettings<CreateVmwareEngineNetworkRequest,VmwareEngineNetwork,OperationMetadata>`

createVmwareEngineNetworkSettings()

public UnaryCallSettings<CreateVmwareEngineNetworkRequest,Operation> createVmwareEngineNetworkSettings()

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

Returns

Type	Description
`UnaryCallSettings<CreateVmwareEngineNetworkRequest,Operation>`

deleteClusterOperationSettings()

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

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

Returns

Type	Description
`OperationCallSettings<DeleteClusterRequest,Empty,OperationMetadata>`

deleteClusterSettings()

public UnaryCallSettings<DeleteClusterRequest,Operation> deleteClusterSettings()

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

Returns

Type	Description
`UnaryCallSettings<DeleteClusterRequest,Operation>`

deleteNetworkPolicyOperationSettings()

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

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

Returns

Type	Description
`OperationCallSettings<DeleteNetworkPolicyRequest,Empty,OperationMetadata>`

deleteNetworkPolicySettings()

public UnaryCallSettings<DeleteNetworkPolicyRequest,Operation> deleteNetworkPolicySettings()

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

Returns

Type	Description
`UnaryCallSettings<DeleteNetworkPolicyRequest,Operation>`

deletePrivateCloudOperationSettings()

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

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

Returns

Type	Description
`OperationCallSettings<DeletePrivateCloudRequest,PrivateCloud,OperationMetadata>`

deletePrivateCloudSettings()

public UnaryCallSettings<DeletePrivateCloudRequest,Operation> deletePrivateCloudSettings()

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

Returns

Type	Description
`UnaryCallSettings<DeletePrivateCloudRequest,Operation>`

deleteVmwareEngineNetworkOperationSettings()

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

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

Returns

Type	Description
`OperationCallSettings<DeleteVmwareEngineNetworkRequest,Empty,OperationMetadata>`

deleteVmwareEngineNetworkSettings()

public UnaryCallSettings<DeleteVmwareEngineNetworkRequest,Operation> deleteVmwareEngineNetworkSettings()

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

Returns

Type	Description
`UnaryCallSettings<DeleteVmwareEngineNetworkRequest,Operation>`

getClusterSettings()

public UnaryCallSettings<GetClusterRequest,Cluster> getClusterSettings()

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

Returns

Type	Description
`UnaryCallSettings<GetClusterRequest,Cluster>`

getHcxActivationKeySettings()

public UnaryCallSettings<GetHcxActivationKeyRequest,HcxActivationKey> getHcxActivationKeySettings()

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

Returns

Type	Description
`UnaryCallSettings<GetHcxActivationKeyRequest,HcxActivationKey>`

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns

Type	Description
`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

Type	Description
`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.

Returns

Type	Description
`UnaryCallSettings<GetNetworkPolicyRequest,NetworkPolicy>`

getNodeTypeSettings()

public UnaryCallSettings<GetNodeTypeRequest,NodeType> getNodeTypeSettings()

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

Returns

Type	Description
`UnaryCallSettings<GetNodeTypeRequest,NodeType>`

getPrivateCloudSettings()

public UnaryCallSettings<GetPrivateCloudRequest,PrivateCloud> getPrivateCloudSettings()

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

Returns

Type	Description
`UnaryCallSettings<GetPrivateCloudRequest,PrivateCloud>`

getVmwareEngineNetworkSettings()

public UnaryCallSettings<GetVmwareEngineNetworkRequest,VmwareEngineNetwork> getVmwareEngineNetworkSettings()

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

Returns

Type	Description
`UnaryCallSettings<GetVmwareEngineNetworkRequest,VmwareEngineNetwork>`

listClustersSettings()

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

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

Returns

Type	Description
`PagedCallSettings<ListClustersRequest,ListClustersResponse,ListClustersPagedResponse>`

listHcxActivationKeysSettings()

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

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

Returns

Type	Description
`PagedCallSettings<ListHcxActivationKeysRequest,ListHcxActivationKeysResponse,ListHcxActivationKeysPagedResponse>`

listLocationsSettings()

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

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

Returns

Type	Description
`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.

Returns

Type	Description
`PagedCallSettings<ListNetworkPoliciesRequest,ListNetworkPoliciesResponse,ListNetworkPoliciesPagedResponse>`

listNodeTypesSettings()

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

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

Returns

Type	Description
`PagedCallSettings<ListNodeTypesRequest,ListNodeTypesResponse,ListNodeTypesPagedResponse>`

listPrivateCloudsSettings()

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

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

Returns

Type	Description
`PagedCallSettings<ListPrivateCloudsRequest,ListPrivateCloudsResponse,ListPrivateCloudsPagedResponse>`

listSubnetsSettings()

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

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

Returns

Type	Description
`PagedCallSettings<ListSubnetsRequest,ListSubnetsResponse,ListSubnetsPagedResponse>`

listVmwareEngineNetworksSettings()

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

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

Returns

Type	Description
`PagedCallSettings<ListVmwareEngineNetworksRequest,ListVmwareEngineNetworksResponse,ListVmwareEngineNetworksPagedResponse>`

resetNsxCredentialsOperationSettings()

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

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

Returns

Type	Description
`OperationCallSettings<ResetNsxCredentialsRequest,PrivateCloud,OperationMetadata>`

resetNsxCredentialsSettings()

public UnaryCallSettings<ResetNsxCredentialsRequest,Operation> resetNsxCredentialsSettings()

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

Returns

Type	Description
`UnaryCallSettings<ResetNsxCredentialsRequest,Operation>`

resetVcenterCredentialsOperationSettings()

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

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

Returns

Type	Description
`OperationCallSettings<ResetVcenterCredentialsRequest,PrivateCloud,OperationMetadata>`

resetVcenterCredentialsSettings()

public UnaryCallSettings<ResetVcenterCredentialsRequest,Operation> resetVcenterCredentialsSettings()

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

Returns

Type	Description
`UnaryCallSettings<ResetVcenterCredentialsRequest,Operation>`

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns

Type	Description
`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.

Returns

Type	Description
`UnaryCallSettings<ShowNsxCredentialsRequest,Credentials>`

showVcenterCredentialsSettings()

public UnaryCallSettings<ShowVcenterCredentialsRequest,Credentials> showVcenterCredentialsSettings()

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

Returns

Type	Description
`UnaryCallSettings<ShowVcenterCredentialsRequest,Credentials>`

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns

Type	Description
`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

Type	Description
`VmwareEngineSettings.Builder`

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

undeletePrivateCloudOperationSettings()

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

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

Returns

Type	Description
`OperationCallSettings<UndeletePrivateCloudRequest,PrivateCloud,OperationMetadata>`

undeletePrivateCloudSettings()

public UnaryCallSettings<UndeletePrivateCloudRequest,Operation> undeletePrivateCloudSettings()

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

Returns

Type	Description
`UnaryCallSettings<UndeletePrivateCloudRequest,Operation>`

updateClusterOperationSettings()

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

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

Returns

Type	Description
`OperationCallSettings<UpdateClusterRequest,Cluster,OperationMetadata>`

updateClusterSettings()

public UnaryCallSettings<UpdateClusterRequest,Operation> updateClusterSettings()

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

Returns

Type	Description
`UnaryCallSettings<UpdateClusterRequest,Operation>`

updateNetworkPolicyOperationSettings()

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

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

Returns

Type	Description
`OperationCallSettings<UpdateNetworkPolicyRequest,NetworkPolicy,OperationMetadata>`

updateNetworkPolicySettings()

public UnaryCallSettings<UpdateNetworkPolicyRequest,Operation> updateNetworkPolicySettings()

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

Returns

Type	Description
`UnaryCallSettings<UpdateNetworkPolicyRequest,Operation>`

updatePrivateCloudOperationSettings()

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

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

Returns

Type	Description
`OperationCallSettings<UpdatePrivateCloudRequest,PrivateCloud,OperationMetadata>`

updatePrivateCloudSettings()

public UnaryCallSettings<UpdatePrivateCloudRequest,Operation> updatePrivateCloudSettings()

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

Returns

Type	Description
`UnaryCallSettings<UpdatePrivateCloudRequest,Operation>`

updateVmwareEngineNetworkOperationSettings()

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

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

Returns

Type	Description
`OperationCallSettings<UpdateVmwareEngineNetworkRequest,VmwareEngineNetwork,OperationMetadata>`

updateVmwareEngineNetworkSettings()

public UnaryCallSettings<UpdateVmwareEngineNetworkRequest,Operation> updateVmwareEngineNetworkSettings()

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

Returns

Type	Description
`UnaryCallSettings<UpdateVmwareEngineNetworkRequest,Operation>`