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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. Name of the EndpointPolicy resource. It matches pattern |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The timestamp when the resource was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The timestamp when the resource was updated. |
↳ 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 |
Google\Cloud\NetworkServices\V1\EndpointMatcher
Required. A matcher that selects endpoints to which the policies should be applied. |
↳ traffic_port_selector |
Google\Cloud\NetworkServices\V1\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}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. Name of the EndpointPolicy resource. It matches pattern
projects/{project}/locations/global/endpointPolicies/{endpoint_policy}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The timestamp when the resource was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp when the resource was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The timestamp when the resource was updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp when the resource was updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional. Set of label tags associated with the EndpointPolicy resource.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional. Set of label tags associated with the EndpointPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getType
Required. The type of endpoint policy. This is primarily used to validate the configuration.
| Returns | |
|---|---|
| Type | Description |
int |
|
setType
Required. The type of endpoint policy. This is primarily used to validate the configuration.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndpointMatcher
Required. A matcher that selects endpoints to which the policies should be applied.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\NetworkServices\V1\EndpointMatcher|null |
|
hasEndpointMatcher
clearEndpointMatcher
setEndpointMatcher
Required. A matcher that selects endpoints to which the policies should be applied.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\NetworkServices\V1\EndpointMatcher
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTrafficPortSelector
Optional. Port selector for the (matched) endpoints. If no port selector is provided, the matched config is applied to all ports.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\NetworkServices\V1\TrafficPortSelector|null |
|
hasTrafficPortSelector
clearTrafficPortSelector
setTrafficPortSelector
Optional. Port selector for the (matched) endpoints. If no port selector is provided, the matched config is applied to all ports.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\NetworkServices\V1\TrafficPortSelector
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. A free-text description of the resource. Max length 1024 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. A free-text description of the resource. Max length 1024 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|