Class: Google::Identity::AccessContextManager::V1::ServicePerimeter

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/identity/accesscontextmanager/v1/service_perimeter.rb

Overview

ServicePerimeter describes a set of Google Cloud resources which can freely import and export data amongst themselves, but not export outside of the ServicePerimeter. If a request with a source within this ServicePerimeter has a target outside of the ServicePerimeter, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google Cloud project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only Google Cloud projects as members, a single Google Cloud project may belong to multiple Service Perimeter Bridges.

Defined Under Namespace

Modules: PerimeterType

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp

Returns Output only. Time the ServicePerimeter was created in UTC.

Returns:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/identity/accesscontextmanager/v1/service_perimeter.rb', line 83

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

  # Specifies the type of the Perimeter. There are two types: regular and
  # bridge. Regular Service Perimeter contains resources, access levels, and
  # restricted services. Every resource can be in at most ONE
  # regular Service Perimeter.
  #
  # In addition to being in a regular service perimeter, a resource can also
  # be in zero or more perimeter bridges.  A perimeter bridge only contains
  # resources.  Cross project operations are permitted if all effected
  # resources share some perimeter (whether bridge or regular). Perimeter
  # Bridge does not contain access levels or services: those are governed
  # entirely by the regular perimeter that resource is in.
  #
  # Perimeter Bridges are typically useful when building more complex toplogies
  # with many independent perimeters that need to share some data with a common
  # perimeter, but should not be able to share data among themselves.
  module PerimeterType
    # Regular Perimeter.
    PERIMETER_TYPE_REGULAR = 0

    # Perimeter Bridge.
    PERIMETER_TYPE_BRIDGE = 1
  end
end

#description ⇒ ::String

Returns Description of the ServicePerimeter and its use. Does not affect behavior.

Returns:

  • (::String) —

    Description of the ServicePerimeter and its use. Does not affect behavior.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/identity/accesscontextmanager/v1/service_perimeter.rb', line 83

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

  # Specifies the type of the Perimeter. There are two types: regular and
  # bridge. Regular Service Perimeter contains resources, access levels, and
  # restricted services. Every resource can be in at most ONE
  # regular Service Perimeter.
  #
  # In addition to being in a regular service perimeter, a resource can also
  # be in zero or more perimeter bridges.  A perimeter bridge only contains
  # resources.  Cross project operations are permitted if all effected
  # resources share some perimeter (whether bridge or regular). Perimeter
  # Bridge does not contain access levels or services: those are governed
  # entirely by the regular perimeter that resource is in.
  #
  # Perimeter Bridges are typically useful when building more complex toplogies
  # with many independent perimeters that need to share some data with a common
  # perimeter, but should not be able to share data among themselves.
  module PerimeterType
    # Regular Perimeter.
    PERIMETER_TYPE_REGULAR = 0

    # Perimeter Bridge.
    PERIMETER_TYPE_BRIDGE = 1
  end
end

#name ⇒ ::String

Returns Required. Resource name for the ServicePerimeter. The short_name component must begin with a letter and only include alphanumeric and '_'. Format: accessPolicies/{policy_id}/servicePerimeters/{short_name}.

Returns:

  • (::String) —

    Required. Resource name for the ServicePerimeter. The short_name component must begin with a letter and only include alphanumeric and '_'. Format: accessPolicies/{policy_id}/servicePerimeters/{short_name}



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/identity/accesscontextmanager/v1/service_perimeter.rb', line 83

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

  # Specifies the type of the Perimeter. There are two types: regular and
  # bridge. Regular Service Perimeter contains resources, access levels, and
  # restricted services. Every resource can be in at most ONE
  # regular Service Perimeter.
  #
  # In addition to being in a regular service perimeter, a resource can also
  # be in zero or more perimeter bridges.  A perimeter bridge only contains
  # resources.  Cross project operations are permitted if all effected
  # resources share some perimeter (whether bridge or regular). Perimeter
  # Bridge does not contain access levels or services: those are governed
  # entirely by the regular perimeter that resource is in.
  #
  # Perimeter Bridges are typically useful when building more complex toplogies
  # with many independent perimeters that need to share some data with a common
  # perimeter, but should not be able to share data among themselves.
  module PerimeterType
    # Regular Perimeter.
    PERIMETER_TYPE_REGULAR = 0

    # Perimeter Bridge.
    PERIMETER_TYPE_BRIDGE = 1
  end
end

#perimeter_type ⇒ ::Google::Identity::AccessContextManager::V1::ServicePerimeter::PerimeterType

Returns Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty.

Returns:

  • (::Google::Identity::AccessContextManager::V1::ServicePerimeter::PerimeterType) —

    Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/identity/accesscontextmanager/v1/service_perimeter.rb', line 83

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

  # Specifies the type of the Perimeter. There are two types: regular and
  # bridge. Regular Service Perimeter contains resources, access levels, and
  # restricted services. Every resource can be in at most ONE
  # regular Service Perimeter.
  #
  # In addition to being in a regular service perimeter, a resource can also
  # be in zero or more perimeter bridges.  A perimeter bridge only contains
  # resources.  Cross project operations are permitted if all effected
  # resources share some perimeter (whether bridge or regular). Perimeter
  # Bridge does not contain access levels or services: those are governed
  # entirely by the regular perimeter that resource is in.
  #
  # Perimeter Bridges are typically useful when building more complex toplogies
  # with many independent perimeters that need to share some data with a common
  # perimeter, but should not be able to share data among themselves.
  module PerimeterType
    # Regular Perimeter.
    PERIMETER_TYPE_REGULAR = 0

    # Perimeter Bridge.
    PERIMETER_TYPE_BRIDGE = 1
  end
end

#spec ⇒ ::Google::Identity::AccessContextManager::V1::ServicePerimeterConfig

Returns Proposed (or dry run) ServicePerimeter configuration. This configuration allows to specify and test ServicePerimeter configuration without enforcing actual access restrictions. Only allowed to be set when the "use_explicit_dry_run_spec" flag is set.

Returns:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/identity/accesscontextmanager/v1/service_perimeter.rb', line 83

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

  # Specifies the type of the Perimeter. There are two types: regular and
  # bridge. Regular Service Perimeter contains resources, access levels, and
  # restricted services. Every resource can be in at most ONE
  # regular Service Perimeter.
  #
  # In addition to being in a regular service perimeter, a resource can also
  # be in zero or more perimeter bridges.  A perimeter bridge only contains
  # resources.  Cross project operations are permitted if all effected
  # resources share some perimeter (whether bridge or regular). Perimeter
  # Bridge does not contain access levels or services: those are governed
  # entirely by the regular perimeter that resource is in.
  #
  # Perimeter Bridges are typically useful when building more complex toplogies
  # with many independent perimeters that need to share some data with a common
  # perimeter, but should not be able to share data among themselves.
  module PerimeterType
    # Regular Perimeter.
    PERIMETER_TYPE_REGULAR = 0

    # Perimeter Bridge.
    PERIMETER_TYPE_BRIDGE = 1
  end
end

#status ⇒ ::Google::Identity::AccessContextManager::V1::ServicePerimeterConfig

Returns Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries.

Returns:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/identity/accesscontextmanager/v1/service_perimeter.rb', line 83

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

  # Specifies the type of the Perimeter. There are two types: regular and
  # bridge. Regular Service Perimeter contains resources, access levels, and
  # restricted services. Every resource can be in at most ONE
  # regular Service Perimeter.
  #
  # In addition to being in a regular service perimeter, a resource can also
  # be in zero or more perimeter bridges.  A perimeter bridge only contains
  # resources.  Cross project operations are permitted if all effected
  # resources share some perimeter (whether bridge or regular). Perimeter
  # Bridge does not contain access levels or services: those are governed
  # entirely by the regular perimeter that resource is in.
  #
  # Perimeter Bridges are typically useful when building more complex toplogies
  # with many independent perimeters that need to share some data with a common
  # perimeter, but should not be able to share data among themselves.
  module PerimeterType
    # Regular Perimeter.
    PERIMETER_TYPE_REGULAR = 0

    # Perimeter Bridge.
    PERIMETER_TYPE_BRIDGE = 1
  end
end

#title ⇒ ::String

Returns Human readable title. Must be unique within the Policy.

Returns:

  • (::String) —

    Human readable title. Must be unique within the Policy.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/identity/accesscontextmanager/v1/service_perimeter.rb', line 83

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

  # Specifies the type of the Perimeter. There are two types: regular and
  # bridge. Regular Service Perimeter contains resources, access levels, and
  # restricted services. Every resource can be in at most ONE
  # regular Service Perimeter.
  #
  # In addition to being in a regular service perimeter, a resource can also
  # be in zero or more perimeter bridges.  A perimeter bridge only contains
  # resources.  Cross project operations are permitted if all effected
  # resources share some perimeter (whether bridge or regular). Perimeter
  # Bridge does not contain access levels or services: those are governed
  # entirely by the regular perimeter that resource is in.
  #
  # Perimeter Bridges are typically useful when building more complex toplogies
  # with many independent perimeters that need to share some data with a common
  # perimeter, but should not be able to share data among themselves.
  module PerimeterType
    # Regular Perimeter.
    PERIMETER_TYPE_REGULAR = 0

    # Perimeter Bridge.
    PERIMETER_TYPE_BRIDGE = 1
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp

Returns Output only. Time the ServicePerimeter was updated in UTC.

Returns:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/identity/accesscontextmanager/v1/service_perimeter.rb', line 83

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

  # Specifies the type of the Perimeter. There are two types: regular and
  # bridge. Regular Service Perimeter contains resources, access levels, and
  # restricted services. Every resource can be in at most ONE
  # regular Service Perimeter.
  #
  # In addition to being in a regular service perimeter, a resource can also
  # be in zero or more perimeter bridges.  A perimeter bridge only contains
  # resources.  Cross project operations are permitted if all effected
  # resources share some perimeter (whether bridge or regular). Perimeter
  # Bridge does not contain access levels or services: those are governed
  # entirely by the regular perimeter that resource is in.
  #
  # Perimeter Bridges are typically useful when building more complex toplogies
  # with many independent perimeters that need to share some data with a common
  # perimeter, but should not be able to share data among themselves.
  module PerimeterType
    # Regular Perimeter.
    PERIMETER_TYPE_REGULAR = 0

    # Perimeter Bridge.
    PERIMETER_TYPE_BRIDGE = 1
  end
end

#use_explicit_dry_run_spec ⇒ ::Boolean

Returns Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly exists for all Service Perimeters, and that spec is identical to the status for those Service Perimeters. When this flag is set, it inhibits the generation of the implicit spec, thereby allowing the user to explicitly provide a configuration ("spec") to use in a dry-run version of the Service Perimeter. This allows the user to test changes to the enforced config ("status") without actually enforcing them. This testing is done through analyzing the differences between currently enforced and suggested restrictions. use_explicit_dry_run_spec must bet set to True if any of the fields in the spec are set to non-default values.

Returns:

  • (::Boolean) —

    Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly exists for all Service Perimeters, and that spec is identical to the status for those Service Perimeters. When this flag is set, it inhibits the generation of the implicit spec, thereby allowing the user to explicitly provide a configuration ("spec") to use in a dry-run version of the Service Perimeter. This allows the user to test changes to the enforced config ("status") without actually enforcing them. This testing is done through analyzing the differences between currently enforced and suggested restrictions. use_explicit_dry_run_spec must bet set to True if any of the fields in the spec are set to non-default values.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/identity/accesscontextmanager/v1/service_perimeter.rb', line 83

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

  # Specifies the type of the Perimeter. There are two types: regular and
  # bridge. Regular Service Perimeter contains resources, access levels, and
  # restricted services. Every resource can be in at most ONE
  # regular Service Perimeter.
  #
  # In addition to being in a regular service perimeter, a resource can also
  # be in zero or more perimeter bridges.  A perimeter bridge only contains
  # resources.  Cross project operations are permitted if all effected
  # resources share some perimeter (whether bridge or regular). Perimeter
  # Bridge does not contain access levels or services: those are governed
  # entirely by the regular perimeter that resource is in.
  #
  # Perimeter Bridges are typically useful when building more complex toplogies
  # with many independent perimeters that need to share some data with a common
  # perimeter, but should not be able to share data among themselves.
  module PerimeterType
    # Regular Perimeter.
    PERIMETER_TYPE_REGULAR = 0

    # Perimeter Bridge.
    PERIMETER_TYPE_BRIDGE = 1
  end
end