Package com.vmware.nsx_policy.global_infra

Interface Certificates

All Superinterfaces:

CertificatesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

CertificatesStub

public interface Certificates
extends com.vmware.vapi.bindings.Service, CertificatesTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.global_infra.CertificatesTypes

_VAPI_SERVICE_ID, LIST_TYPE_API_CERTIFICATE, LIST_TYPE_CLUSTER_API_CERTIFICATE

Method Summary

Modifier and Type	Method	Description
TlsCertificate	get(java.lang.String certificateId, java.lang.Boolean details)	Returns information for the specified certificate ID, including the certificate's id; pem_encoded data; and history of the certificate (who created or modified it and when).
void	get(java.lang.String certificateId, java.lang.Boolean details, com.vmware.vapi.bindings.client.AsyncCallback<TlsCertificate> asyncCallback)	Returns information for the specified certificate ID, including the certificate's id; pem_encoded data; and history of the certificate (who created or modified it and when).
void	get(java.lang.String certificateId, java.lang.Boolean details, com.vmware.vapi.bindings.client.AsyncCallback<TlsCertificate> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Returns information for the specified certificate ID, including the certificate's id; pem_encoded data; and history of the certificate (who created or modified it and when).
TlsCertificate	get(java.lang.String certificateId, java.lang.Boolean details, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Returns information for the specified certificate ID, including the certificate's id; pem_encoded data; and history of the certificate (who created or modified it and when).
TlsCertificateList	list(java.lang.String cursor, java.lang.Boolean details, java.lang.String includedFields, java.lang.String nodeId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type)	Returns all certificate information viewable by the user, including each certificate's id; pem_encoded data; and history of the certificate (who created or modified it and when).
void	list(java.lang.String cursor, java.lang.Boolean details, java.lang.String includedFields, java.lang.String nodeId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, com.vmware.vapi.bindings.client.AsyncCallback<TlsCertificateList> asyncCallback)	Returns all certificate information viewable by the user, including each certificate's id; pem_encoded data; and history of the certificate (who created or modified it and when).
void	list(java.lang.String cursor, java.lang.Boolean details, java.lang.String includedFields, java.lang.String nodeId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, com.vmware.vapi.bindings.client.AsyncCallback<TlsCertificateList> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Returns all certificate information viewable by the user, including each certificate's id; pem_encoded data; and history of the certificate (who created or modified it and when).
TlsCertificateList	list(java.lang.String cursor, java.lang.Boolean details, java.lang.String includedFields, java.lang.String nodeId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Returns all certificate information viewable by the user, including each certificate's id; pem_encoded data; and history of the certificate (who created or modified it and when).

Method Detail

get

TlsCertificate get(java.lang.String certificateId,
                   java.lang.Boolean details)

Returns information for the specified certificate ID, including the certificate's id; pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

certificateId - ID of certificate to read (required)

details - whether to expand the pem data and show all its details (optional, default to false)

Returns:

com.vmware.nsx_policy.model.TlsCertificate

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

TlsCertificate get(java.lang.String certificateId,
                   java.lang.Boolean details,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information for the specified certificate ID, including the certificate's id; pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

certificateId - ID of certificate to read (required)

details - whether to expand the pem data and show all its details (optional, default to false)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.TlsCertificate

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

void get(java.lang.String certificateId,
         java.lang.Boolean details,
         com.vmware.vapi.bindings.client.AsyncCallback<TlsCertificate> asyncCallback)

Returns information for the specified certificate ID, including the certificate's id; pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx_policy.model.TlsCertificate

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

certificateId - ID of certificate to read (required)

details - whether to expand the pem data and show all its details (optional, default to false)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String certificateId,
         java.lang.Boolean details,
         com.vmware.vapi.bindings.client.AsyncCallback<TlsCertificate> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information for the specified certificate ID, including the certificate's id; pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.

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:
com.vmware.nsx_policy.model.TlsCertificate

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

certificateId - ID of certificate to read (required)

details - whether to expand the pem data and show all its details (optional, default to false)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

list

TlsCertificateList list(java.lang.String cursor,
                        java.lang.Boolean details,
                        java.lang.String includedFields,
                        java.lang.String nodeId,
                        java.lang.Long pageSize,
                        java.lang.Boolean sortAscending,
                        java.lang.String sortBy,
                        java.lang.String type)

Returns all certificate information viewable by the user, including each certificate's id; pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

details - whether to expand the pem data and show all its details (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

nodeId - Node ID of certificate to return (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type of certificate to return (optional)

Returns:

com.vmware.nsx_policy.model.TlsCertificateList

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

TlsCertificateList list(java.lang.String cursor,
                        java.lang.Boolean details,
                        java.lang.String includedFields,
                        java.lang.String nodeId,
                        java.lang.Long pageSize,
                        java.lang.Boolean sortAscending,
                        java.lang.String sortBy,
                        java.lang.String type,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns all certificate information viewable by the user, including each certificate's id; pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

details - whether to expand the pem data and show all its details (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

nodeId - Node ID of certificate to return (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type of certificate to return (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.TlsCertificateList

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

void list(java.lang.String cursor,
          java.lang.Boolean details,
          java.lang.String includedFields,
          java.lang.String nodeId,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String type,
          com.vmware.vapi.bindings.client.AsyncCallback<TlsCertificateList> asyncCallback)

Returns all certificate information viewable by the user, including each certificate's id; pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx_policy.model.TlsCertificateList

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

details - whether to expand the pem data and show all its details (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

nodeId - Node ID of certificate to return (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type of certificate to return (optional)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

void list(java.lang.String cursor,
          java.lang.Boolean details,
          java.lang.String includedFields,
          java.lang.String nodeId,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String type,
          com.vmware.vapi.bindings.client.AsyncCallback<TlsCertificateList> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns all certificate information viewable by the user, including each certificate's id; pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.

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:
com.vmware.nsx_policy.model.TlsCertificateList

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

details - whether to expand the pem data and show all its details (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

nodeId - Node ID of certificate to return (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

type - Type of certificate to return (optional)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.