Cloud KMS V1 Client - Class ServiceResolver (1.17.0)

Reference documentation and code samples for the Cloud KMS V1 Client class ServiceResolver.

A ServiceResolver represents an EKM replica that can be reached within an EkmConnection.

Generated from protobuf message google.cloud.kms.v1.EkmConnection.ServiceResolver

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ service_directory_service string

Required. The resource name of the Service Directory service pointing to an EKM replica, in the format projects/*/locations/*/namespaces/*/services/*.

↳ endpoint_filter string

Optional. The filter applied to the endpoints of the resolved service. If no filter is specified, all endpoints will be considered. An endpoint will be chosen arbitrarily from the filtered list for each request. For endpoint filter syntax and examples, see https://cloud.google.com/service-directory/docs/reference/rpc/google.cloud.servicedirectory.v1#resolveservicerequest.

↳ hostname string

Required. The hostname of the EKM replica used at TLS and HTTP layers.

↳ server_certificates array<Google\Cloud\Kms\V1\Certificate>

Required. A list of leaf server certificates used to authenticate HTTPS connections to the EKM replica. Currently, a maximum of 10 Certificate is supported.

getServiceDirectoryService

Required. The resource name of the Service Directory service pointing to an EKM replica, in the format projects/*/locations/*/namespaces/*/services/*.

Returns
TypeDescription
string

setServiceDirectoryService

Required. The resource name of the Service Directory service pointing to an EKM replica, in the format projects/*/locations/*/namespaces/*/services/*.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEndpointFilter

Optional. The filter applied to the endpoints of the resolved service. If no filter is specified, all endpoints will be considered. An endpoint will be chosen arbitrarily from the filtered list for each request.

For endpoint filter syntax and examples, see https://cloud.google.com/service-directory/docs/reference/rpc/google.cloud.servicedirectory.v1#resolveservicerequest.

Returns
TypeDescription
string

setEndpointFilter

Optional. The filter applied to the endpoints of the resolved service. If no filter is specified, all endpoints will be considered. An endpoint will be chosen arbitrarily from the filtered list for each request.

For endpoint filter syntax and examples, see https://cloud.google.com/service-directory/docs/reference/rpc/google.cloud.servicedirectory.v1#resolveservicerequest.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getHostname

Required. The hostname of the EKM replica used at TLS and HTTP layers.

Returns
TypeDescription
string

setHostname

Required. The hostname of the EKM replica used at TLS and HTTP layers.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getServerCertificates

Required. A list of leaf server certificates used to authenticate HTTPS connections to the EKM replica. Currently, a maximum of 10 Certificate is supported.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setServerCertificates

Required. A list of leaf server certificates used to authenticate HTTPS connections to the EKM replica. Currently, a maximum of 10 Certificate is supported.

Parameter
NameDescription
var array<Google\Cloud\Kms\V1\Certificate>
Returns
TypeDescription
$this