Class VmwareEngineStubSettings (0.8.0)

public class VmwareEngineStubSettings extends StubSettings<VmwareEngineStubSettings>

Settings class to configure an instance of VmwareEngineStub.

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

Inheritance

java.lang.Object > StubSettings > VmwareEngineStubSettings

Static Methods

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

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static VmwareEngineStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
VmwareEngineStubSettings.Builder

newBuilder(ClientContext clientContext)

public static VmwareEngineStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
VmwareEngineStubSettings.Builder

newHttpJsonBuilder()

public static VmwareEngineStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
VmwareEngineStubSettings.Builder

Constructors

VmwareEngineStubSettings(VmwareEngineStubSettings.Builder settingsBuilder)

protected VmwareEngineStubSettings(VmwareEngineStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderVmwareEngineStubSettings.Builder

Methods

createClusterOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateClusterRequest,Cluster,OperationMetadata>

createClusterSettings()

public UnaryCallSettings<CreateClusterRequest,Operation> createClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateClusterRequest,Operation>

createHcxActivationKeyOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateHcxActivationKeyRequest,HcxActivationKey,OperationMetadata>

createHcxActivationKeySettings()

public UnaryCallSettings<CreateHcxActivationKeyRequest,Operation> createHcxActivationKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateHcxActivationKeyRequest,Operation>

createNetworkPolicyOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateNetworkPolicyRequest,NetworkPolicy,OperationMetadata>

createNetworkPolicySettings()

public UnaryCallSettings<CreateNetworkPolicyRequest,Operation> createNetworkPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateNetworkPolicyRequest,Operation>

createPrivateCloudOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreatePrivateCloudRequest,PrivateCloud,OperationMetadata>

createPrivateCloudSettings()

public UnaryCallSettings<CreatePrivateCloudRequest,Operation> createPrivateCloudSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreatePrivateCloudRequest,Operation>

createStub()

public VmwareEngineStub createStub()
Returns
TypeDescription
VmwareEngineStub
Exceptions
TypeDescription
IOException

createVmwareEngineNetworkOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateVmwareEngineNetworkRequest,VmwareEngineNetwork,OperationMetadata>

createVmwareEngineNetworkSettings()

public UnaryCallSettings<CreateVmwareEngineNetworkRequest,Operation> createVmwareEngineNetworkSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateVmwareEngineNetworkRequest,Operation>

deleteClusterOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteClusterRequest,Empty,OperationMetadata>

deleteClusterSettings()

public UnaryCallSettings<DeleteClusterRequest,Operation> deleteClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteClusterRequest,Operation>

deleteNetworkPolicyOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteNetworkPolicyRequest,Empty,OperationMetadata>

deleteNetworkPolicySettings()

public UnaryCallSettings<DeleteNetworkPolicyRequest,Operation> deleteNetworkPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteNetworkPolicyRequest,Operation>

deletePrivateCloudOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeletePrivateCloudRequest,PrivateCloud,OperationMetadata>

deletePrivateCloudSettings()

public UnaryCallSettings<DeletePrivateCloudRequest,Operation> deletePrivateCloudSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeletePrivateCloudRequest,Operation>

deleteVmwareEngineNetworkOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteVmwareEngineNetworkRequest,Empty,OperationMetadata>

deleteVmwareEngineNetworkSettings()

public UnaryCallSettings<DeleteVmwareEngineNetworkRequest,Operation> deleteVmwareEngineNetworkSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteVmwareEngineNetworkRequest,Operation>

getClusterSettings()

public UnaryCallSettings<GetClusterRequest,Cluster> getClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetClusterRequest,Cluster>

getHcxActivationKeySettings()

public UnaryCallSettings<GetHcxActivationKeyRequest,HcxActivationKey> getHcxActivationKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<GetHcxActivationKeyRequest,HcxActivationKey>

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.

Returns
TypeDescription
UnaryCallSettings<GetNetworkPolicyRequest,NetworkPolicy>

getNodeTypeSettings()

public UnaryCallSettings<GetNodeTypeRequest,NodeType> getNodeTypeSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetNodeTypeRequest,NodeType>

getPrivateCloudSettings()

public UnaryCallSettings<GetPrivateCloudRequest,PrivateCloud> getPrivateCloudSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetPrivateCloudRequest,PrivateCloud>

getVmwareEngineNetworkSettings()

public UnaryCallSettings<GetVmwareEngineNetworkRequest,VmwareEngineNetwork> getVmwareEngineNetworkSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetVmwareEngineNetworkRequest,VmwareEngineNetwork>

listClustersSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListClustersRequest,ListClustersResponse,ListClustersPagedResponse>

listHcxActivationKeysSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListHcxActivationKeysRequest,ListHcxActivationKeysResponse,ListHcxActivationKeysPagedResponse>

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.

Returns
TypeDescription
PagedCallSettings<ListNetworkPoliciesRequest,ListNetworkPoliciesResponse,ListNetworkPoliciesPagedResponse>

listNodeTypesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListNodeTypesRequest,ListNodeTypesResponse,ListNodeTypesPagedResponse>

listPrivateCloudsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListPrivateCloudsRequest,ListPrivateCloudsResponse,ListPrivateCloudsPagedResponse>

listSubnetsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListSubnetsRequest,ListSubnetsResponse,ListSubnetsPagedResponse>

listVmwareEngineNetworksSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListVmwareEngineNetworksRequest,ListVmwareEngineNetworksResponse,ListVmwareEngineNetworksPagedResponse>

resetNsxCredentialsOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<ResetNsxCredentialsRequest,PrivateCloud,OperationMetadata>

resetNsxCredentialsSettings()

public UnaryCallSettings<ResetNsxCredentialsRequest,Operation> resetNsxCredentialsSettings()

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

Returns
TypeDescription
UnaryCallSettings<ResetNsxCredentialsRequest,Operation>

resetVcenterCredentialsOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<ResetVcenterCredentialsRequest,PrivateCloud,OperationMetadata>

resetVcenterCredentialsSettings()

public UnaryCallSettings<ResetVcenterCredentialsRequest,Operation> resetVcenterCredentialsSettings()

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

Returns
TypeDescription
UnaryCallSettings<ResetVcenterCredentialsRequest,Operation>

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.

Returns
TypeDescription
UnaryCallSettings<ShowNsxCredentialsRequest,Credentials>

showVcenterCredentialsSettings()

public UnaryCallSettings<ShowVcenterCredentialsRequest,Credentials> showVcenterCredentialsSettings()

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

Returns
TypeDescription
UnaryCallSettings<ShowVcenterCredentialsRequest,Credentials>

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 VmwareEngineStubSettings.Builder toBuilder()

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

Returns
TypeDescription
VmwareEngineStubSettings.Builder
Overrides

undeletePrivateCloudOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UndeletePrivateCloudRequest,PrivateCloud,OperationMetadata>

undeletePrivateCloudSettings()

public UnaryCallSettings<UndeletePrivateCloudRequest,Operation> undeletePrivateCloudSettings()

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

Returns
TypeDescription
UnaryCallSettings<UndeletePrivateCloudRequest,Operation>

updateClusterOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateClusterRequest,Cluster,OperationMetadata>

updateClusterSettings()

public UnaryCallSettings<UpdateClusterRequest,Operation> updateClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateClusterRequest,Operation>

updateNetworkPolicyOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateNetworkPolicyRequest,NetworkPolicy,OperationMetadata>

updateNetworkPolicySettings()

public UnaryCallSettings<UpdateNetworkPolicyRequest,Operation> updateNetworkPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateNetworkPolicyRequest,Operation>

updatePrivateCloudOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdatePrivateCloudRequest,PrivateCloud,OperationMetadata>

updatePrivateCloudSettings()

public UnaryCallSettings<UpdatePrivateCloudRequest,Operation> updatePrivateCloudSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdatePrivateCloudRequest,Operation>

updateVmwareEngineNetworkOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateVmwareEngineNetworkRequest,VmwareEngineNetwork,OperationMetadata>

updateVmwareEngineNetworkSettings()

public UnaryCallSettings<UpdateVmwareEngineNetworkRequest,Operation> updateVmwareEngineNetworkSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateVmwareEngineNetworkRequest,Operation>