Reference documentation and code samples for the Google Cloud Network Services V1 Client class EndpointPolicy.
EndpointPolicy is a resource that helps apply desired configuration on the endpoints that match specific criteria.
For example, this resource can be used to apply "authentication config" an all endpoints that serve on port 8080.
Generated from protobuf message google.cloud.networkservices.v1.EndpointPolicy
Namespace
Google \ Cloud \ NetworkServices \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. Name of the EndpointPolicy resource. It matches pattern projects/{project}/locations/global/endpointPolicies/{endpoint_policy}
.
↳ create_time
↳ update_time
↳ labels
array| Google\Protobuf\Internal\MapField
Optional. Set of label tags associated with the EndpointPolicy resource.
↳ type
int
Required. The type of endpoint policy. This is primarily used to validate the configuration.
↳ authorization_policy
string
Optional. This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. Refer to Authorization. If this field is not specified, authorization is disabled(no authz checks) for this endpoint.
↳ endpoint_matcher
↳ traffic_port_selector
TrafficPortSelector
Optional. Port selector for the (matched) endpoints. If no port selector is provided, the matched config is applied to all ports.
↳ description
string
Optional. A free-text description of the resource. Max length 1024 characters.
↳ server_tls_policy
string
Optional. A URL referring to ServerTlsPolicy resource. ServerTlsPolicy is used to determine the authentication policy to be applied to terminate the inbound traffic at the identified backends. If this field is not set, authentication is disabled(open) for this endpoint.
↳ client_tls_policy
string
Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY.
getName
Required. Name of the EndpointPolicy resource. It matches pattern projects/{project}/locations/global/endpointPolicies/{endpoint_policy}
.
string
setName
Required. Name of the EndpointPolicy resource. It matches pattern projects/{project}/locations/global/endpointPolicies/{endpoint_policy}
.
var
string
$this
getCreateTime
Output only. The timestamp when the resource was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp when the resource was created.
$this
getUpdateTime
Output only. The timestamp when the resource was updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp when the resource was updated.
$this
getLabels
Optional. Set of label tags associated with the EndpointPolicy resource.
setLabels
Optional. Set of label tags associated with the EndpointPolicy resource.
$this
getType
Required. The type of endpoint policy. This is primarily used to validate the configuration.
int
setType
Required. The type of endpoint policy. This is primarily used to validate the configuration.
var
int
$this
getAuthorizationPolicy
Optional. This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. Refer to Authorization. If this field is not specified, authorization is disabled(no authz checks) for this endpoint.
string
setAuthorizationPolicy
Optional. This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. Refer to Authorization. If this field is not specified, authorization is disabled(no authz checks) for this endpoint.
var
string
$this
getEndpointMatcher
Required. A matcher that selects endpoints to which the policies should be applied.
hasEndpointMatcher
clearEndpointMatcher
setEndpointMatcher
Required. A matcher that selects endpoints to which the policies should be applied.
$this
getTrafficPortSelector
Optional. Port selector for the (matched) endpoints. If no port selector is provided, the matched config is applied to all ports.
hasTrafficPortSelector
clearTrafficPortSelector
setTrafficPortSelector
Optional. Port selector for the (matched) endpoints. If no port selector is provided, the matched config is applied to all ports.
$this
getDescription
Optional. A free-text description of the resource. Max length 1024 characters.
string
setDescription
Optional. A free-text description of the resource. Max length 1024 characters.
var
string
$this
getServerTlsPolicy
Optional. A URL referring to ServerTlsPolicy resource. ServerTlsPolicy is used to determine the authentication policy to be applied to terminate the inbound traffic at the identified backends. If this field is not set, authentication is disabled(open) for this endpoint.
string
setServerTlsPolicy
Optional. A URL referring to ServerTlsPolicy resource. ServerTlsPolicy is used to determine the authentication policy to be applied to terminate the inbound traffic at the identified backends. If this field is not set, authentication is disabled(open) for this endpoint.
var
string
$this
getClientTlsPolicy
Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY.
string
setClientTlsPolicy
Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY.
var
string
$this
