public class ConfigOptionsStub extends com.vmware.vapi.internal.bindings.Stub implements ConfigOptions
ConfigOptions
API service.
WARNING: Internal class, subject to change in future versions.
ConfigOptionsTypes.GetParams, ConfigOptionsTypes.Info
apiProvider, converter, ifaceId, retryPolicy, securityContext
_VAPI_SERVICE_ID
Constructor and Description |
---|
ConfigOptionsStub(com.vmware.vapi.core.ApiProvider apiProvider,
com.vmware.vapi.bindings.StubConfigurationBase config) |
ConfigOptionsStub(com.vmware.vapi.core.ApiProvider apiProvider,
com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
com.vmware.vapi.bindings.StubConfigurationBase config) |
Modifier and Type | Method and Description |
---|---|
ConfigOptionsTypes.Info |
get(ConfigOptionsTypes.GetParams params)
Query for the
vim.vm.ConfigOption from the hosts in the specified
clusters. |
void |
get(ConfigOptionsTypes.GetParams params,
com.vmware.vapi.bindings.client.AsyncCallback<ConfigOptionsTypes.Info> asyncCallback)
Query for the
vim.vm.ConfigOption from the hosts in the specified
clusters. |
void |
get(ConfigOptionsTypes.GetParams params,
com.vmware.vapi.bindings.client.AsyncCallback<ConfigOptionsTypes.Info> asyncCallback,
com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Query for the
vim.vm.ConfigOption from the hosts in the specified
clusters. |
ConfigOptionsTypes.Info |
get(ConfigOptionsTypes.GetParams params,
com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Query for the
vim.vm.ConfigOption from the hosts in the specified
clusters. |
public ConfigOptionsStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, com.vmware.vapi.bindings.StubConfigurationBase config)
public ConfigOptionsStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
public ConfigOptionsTypes.Info get(ConfigOptionsTypes.GetParams params)
ConfigOptions
vim.vm.ConfigOption
from the hosts in the specified
clusters. The filter spec may be optionally used to narrow the result to a
specific config option by the key returned from ConfigOptionDescriptors.list(com.vmware.vcenter.environment_browser.ConfigOptionDescriptorsTypes.ListParams)
as well as
one or more guest OS identifier(s). If the config option key is not specified,
then the default config option for the specified cluster(s) is returned.
This method requires additional api_release
request parameter which must
be used to guarantee compatibility with future releases of the API. Consult the
vSphere Automation SDKs Programming Guide for more information.
Synchronous method overload. Result of the invocation will be reported as a method return value.
get
in interface ConfigOptions
params
- The query specification used to provide key, guest OS identifier(s), clusters.vim.vm.ConfigOption
)
object. If none of the specified clusters have any available hosts, or if the
information requested in filters is not available in any of the the specified
clusters, then null is returned.public ConfigOptionsTypes.Info get(ConfigOptionsTypes.GetParams params, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
ConfigOptions
vim.vm.ConfigOption
from the hosts in the specified
clusters. The filter spec may be optionally used to narrow the result to a
specific config option by the key returned from ConfigOptionDescriptors.list(com.vmware.vcenter.environment_browser.ConfigOptionDescriptorsTypes.ListParams)
as well as
one or more guest OS identifier(s). If the config option key is not specified,
then the default config option for the specified cluster(s) is returned.
This method requires additional api_release
request parameter which must
be used to guarantee compatibility with future releases of the API. Consult the
vSphere Automation SDKs Programming Guide for more information.
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
get
in interface ConfigOptions
params
- The query specification used to provide key, guest OS identifier(s), clusters.invocationConfig
- Configuration for the method invocation.vim.vm.ConfigOption
)
object. If none of the specified clusters have any available hosts, or if the
information requested in filters is not available in any of the the specified
clusters, then null is returned.public void get(ConfigOptionsTypes.GetParams params, com.vmware.vapi.bindings.client.AsyncCallback<ConfigOptionsTypes.Info> asyncCallback)
ConfigOptions
vim.vm.ConfigOption
from the hosts in the specified
clusters. The filter spec may be optionally used to narrow the result to a
specific config option by the key returned from ConfigOptionDescriptors.list(com.vmware.vcenter.environment_browser.ConfigOptionDescriptorsTypes.ListParams)
as well as
one or more guest OS identifier(s). If the config option key is not specified,
then the default config option for the specified cluster(s) is returned.
This method requires additional api_release
request parameter which must
be used to guarantee compatibility with future releases of the API. Consult the
vSphere Automation SDKs Programming Guide for more information.
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
the VI/JSON representation of the (vim.vm.ConfigOption
)
object. If none of the specified clusters have any available hosts, or if the
information requested in filters is not available in any of the the specified
clusters, then null is returned.
Operation Errors:
Error
- if the system reports an error while responding to the request.
InvalidArgument
- if invalid input is passed like invalid key, OS or cluster.
NotFound
- if at least one of the specified clusters cannot be located.
Unauthenticated
- if the user cannot be authenticated.
Unauthorized
- if the user doesn't have the required privileges for all the specified clusters.
Unauthorized
- if you do not have all of the privileges described as follows:
ClusterComputeResource
referenced by the property ConfigOptionsTypes.GetParams.getClusters()
requires System.View
. get
in interface ConfigOptions
params
- The query specification used to provide key, guest OS identifier(s), clusters.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.public void get(ConfigOptionsTypes.GetParams params, com.vmware.vapi.bindings.client.AsyncCallback<ConfigOptionsTypes.Info> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
ConfigOptions
vim.vm.ConfigOption
from the hosts in the specified
clusters. The filter spec may be optionally used to narrow the result to a
specific config option by the key returned from ConfigOptionDescriptors.list(com.vmware.vcenter.environment_browser.ConfigOptionDescriptorsTypes.ListParams)
as well as
one or more guest OS identifier(s). If the config option key is not specified,
then the default config option for the specified cluster(s) is returned.
This method requires additional api_release
request parameter which must
be used to guarantee compatibility with future releases of the API. Consult the
vSphere Automation SDKs Programming Guide for more information.
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
the VI/JSON representation of the (vim.vm.ConfigOption
)
object. If none of the specified clusters have any available hosts, or if the
information requested in filters is not available in any of the the specified
clusters, then null is returned.
Operation Errors:
Error
- if the system reports an error while responding to the request.
InvalidArgument
- if invalid input is passed like invalid key, OS or cluster.
NotFound
- if at least one of the specified clusters cannot be located.
Unauthenticated
- if the user cannot be authenticated.
Unauthorized
- if the user doesn't have the required privileges for all the specified clusters.
Unauthorized
- if you do not have all of the privileges described as follows:
ClusterComputeResource
referenced by the property ConfigOptionsTypes.GetParams.getClusters()
requires System.View
. get
in interface ConfigOptions
params
- The query specification used to provide key, guest OS identifier(s), clusters.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.