Class: Google::Cloud::NetworkServices::V1::EndpointPolicy

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/networkservices/v1/endpoint_policy.rb

Overview

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.

Defined Under Namespace

Modules: EndpointPolicyType Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#authorization_policy ⇒ ::String

Returns 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:

  • (::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.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/networkservices/v1/endpoint_policy.rb', line 80

class EndpointPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of endpoint policy.
  module EndpointPolicyType
    # Default value. Must not be used.
    ENDPOINT_POLICY_TYPE_UNSPECIFIED = 0

    # Represents a proxy deployed as a sidecar.
    SIDECAR_PROXY = 1

    # Represents a proxyless gRPC backend.
    GRPC_SERVER = 2
  end
end

#client_tls_policy ⇒ ::String

Returns 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:

  • (::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.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/networkservices/v1/endpoint_policy.rb', line 80

class EndpointPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of endpoint policy.
  module EndpointPolicyType
    # Default value. Must not be used.
    ENDPOINT_POLICY_TYPE_UNSPECIFIED = 0

    # Represents a proxy deployed as a sidecar.
    SIDECAR_PROXY = 1

    # Represents a proxyless gRPC backend.
    GRPC_SERVER = 2
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The timestamp when the resource was created.

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/networkservices/v1/endpoint_policy.rb', line 80

class EndpointPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of endpoint policy.
  module EndpointPolicyType
    # Default value. Must not be used.
    ENDPOINT_POLICY_TYPE_UNSPECIFIED = 0

    # Represents a proxy deployed as a sidecar.
    SIDECAR_PROXY = 1

    # Represents a proxyless gRPC backend.
    GRPC_SERVER = 2
  end
end

#description ⇒ ::String

Returns Optional. A free-text description of the resource. Max length 1024 characters.

Returns:

  • (::String) —

    Optional. A free-text description of the resource. Max length 1024 characters.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/networkservices/v1/endpoint_policy.rb', line 80

class EndpointPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of endpoint policy.
  module EndpointPolicyType
    # Default value. Must not be used.
    ENDPOINT_POLICY_TYPE_UNSPECIFIED = 0

    # Represents a proxy deployed as a sidecar.
    SIDECAR_PROXY = 1

    # Represents a proxyless gRPC backend.
    GRPC_SERVER = 2
  end
end

#endpoint_matcher ⇒ ::Google::Cloud::NetworkServices::V1::EndpointMatcher

Returns Required. A matcher that selects endpoints to which the policies should be applied.

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/networkservices/v1/endpoint_policy.rb', line 80

class EndpointPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of endpoint policy.
  module EndpointPolicyType
    # Default value. Must not be used.
    ENDPOINT_POLICY_TYPE_UNSPECIFIED = 0

    # Represents a proxy deployed as a sidecar.
    SIDECAR_PROXY = 1

    # Represents a proxyless gRPC backend.
    GRPC_SERVER = 2
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. Set of label tags associated with the EndpointPolicy resource.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. Set of label tags associated with the EndpointPolicy resource.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/networkservices/v1/endpoint_policy.rb', line 80

class EndpointPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of endpoint policy.
  module EndpointPolicyType
    # Default value. Must not be used.
    ENDPOINT_POLICY_TYPE_UNSPECIFIED = 0

    # Represents a proxy deployed as a sidecar.
    SIDECAR_PROXY = 1

    # Represents a proxyless gRPC backend.
    GRPC_SERVER = 2
  end
end

#name ⇒ ::String

Returns Required. Name of the EndpointPolicy resource. It matches pattern projects/{project}/locations/global/endpointPolicies/{endpoint_policy}.

Returns:

  • (::String) —

    Required. Name of the EndpointPolicy resource. It matches pattern projects/{project}/locations/global/endpointPolicies/{endpoint_policy}.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/networkservices/v1/endpoint_policy.rb', line 80

class EndpointPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of endpoint policy.
  module EndpointPolicyType
    # Default value. Must not be used.
    ENDPOINT_POLICY_TYPE_UNSPECIFIED = 0

    # Represents a proxy deployed as a sidecar.
    SIDECAR_PROXY = 1

    # Represents a proxyless gRPC backend.
    GRPC_SERVER = 2
  end
end

#server_tls_policy ⇒ ::String

Returns 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:

  • (::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.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/networkservices/v1/endpoint_policy.rb', line 80

class EndpointPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of endpoint policy.
  module EndpointPolicyType
    # Default value. Must not be used.
    ENDPOINT_POLICY_TYPE_UNSPECIFIED = 0

    # Represents a proxy deployed as a sidecar.
    SIDECAR_PROXY = 1

    # Represents a proxyless gRPC backend.
    GRPC_SERVER = 2
  end
end

#traffic_port_selector ⇒ ::Google::Cloud::NetworkServices::V1::TrafficPortSelector

Returns Optional. Port selector for the (matched) endpoints. If no port selector is provided, the matched config is applied to all ports.

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/networkservices/v1/endpoint_policy.rb', line 80

class EndpointPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of endpoint policy.
  module EndpointPolicyType
    # Default value. Must not be used.
    ENDPOINT_POLICY_TYPE_UNSPECIFIED = 0

    # Represents a proxy deployed as a sidecar.
    SIDECAR_PROXY = 1

    # Represents a proxyless gRPC backend.
    GRPC_SERVER = 2
  end
end

#type ⇒ ::Google::Cloud::NetworkServices::V1::EndpointPolicy::EndpointPolicyType

Returns Required. The type of endpoint policy. This is primarily used to validate the configuration.

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/networkservices/v1/endpoint_policy.rb', line 80

class EndpointPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of endpoint policy.
  module EndpointPolicyType
    # Default value. Must not be used.
    ENDPOINT_POLICY_TYPE_UNSPECIFIED = 0

    # Represents a proxy deployed as a sidecar.
    SIDECAR_PROXY = 1

    # Represents a proxyless gRPC backend.
    GRPC_SERVER = 2
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The timestamp when the resource was updated.

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/networkservices/v1/endpoint_policy.rb', line 80

class EndpointPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of endpoint policy.
  module EndpointPolicyType
    # Default value. Must not be used.
    ENDPOINT_POLICY_TYPE_UNSPECIFIED = 0

    # Represents a proxy deployed as a sidecar.
    SIDECAR_PROXY = 1

    # Represents a proxyless gRPC backend.
    GRPC_SERVER = 2
  end
end