Apigee API . organizations . environments . targetservers

Instance Methods

create(parent, body=None, name=None, x__xgafv=None)

Creates a TargetServer in the specified environment.

delete(name, x__xgafv=None)

Deletes a TargetServer from an environment. Returns the deleted

get(name, x__xgafv=None)

Gets a TargetServer resource.

update(name, body=None, x__xgafv=None)

Updates an existing TargetServer. Note that this operation has PUT

Method Details

create(parent, body=None, name=None, x__xgafv=None)
Creates a TargetServer in the specified environment.

Args:
  parent: string, Required. The parent environment name under which the TargetServer will
be created. Must be of the form `organizations/{org}/environments/{env}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # TargetServer configuration. TargetServers are used to decouple a proxy's
    # TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
  "host": "A String", # Required. The host name this target connects to. Value must be a valid
      # hostname as described by RFC-1123.
  "name": "A String", # Required. The resource id of this target server. Values must match the
      # regular expression
  "description": "A String", # Optional. A human-readable description of this TargetServer.
  "port": 42, # Required. The port number this target connects to on the given host. Value
      # must be between 1 and 65535, inclusive.
  "isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers
      # are used in load balancing configurations, and one or more TargetServers
      # need to taken out of rotation periodically. Defaults to true.
  "sSLInfo": { # TLS configuration information for # Optional. Specifies TLS configuration info for this TargetServer. The JSON
      # name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge
      # originally supported SSL, and the name is still used for TLS configuration.
      # VirtualHosts and
      # TargetServers.
    "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names
        # listed in:
        # http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites
      "A String",
    ],
    "enabled": True or False, # Required. Enables one-way TLS.
    "trustStore": "A String", # The resource ID of the truststore.
        # References not yet supported.
    "keyAlias": "A String", # Required if `client_auth_enabled` is true. The resource ID for the
        # alias containing the private key and cert.
    "ignoreValidationErrors": True or False, # If true, Edge ignores TLS certificate errors. Valid when configuring TLS
        # for target servers and target endpoints, and when configuring virtual hosts
        # that use 2-way TLS.
        #
        # When used with a target endpoint/target server, if the backend system uses
        # SNI and returns a cert with a subject Distinguished Name (DN) that does not
        # match the hostname, there is no way to ignore the error and the connection
        # fails.
    "protocols": [ # The TLS versioins to be used.
      "A String",
    ],
    "commonName": { # The TLS Common Name of the certificate.
      "value": "A String", # The TLS Common Name string of the certificate.
      "wildcardMatch": True or False, # Indicates whether the cert should be matched against as a wildcard cert.
    },
    "clientAuthEnabled": True or False, # Optional. Enables two-way TLS.
    "keyStore": "A String", # Required if `client_auth_enabled` is true. The resource ID of the
        # keystore. References not yet supported.
  },
}

  name: string, Optional. The ID to give the TargetServer. This will overwrite the
value in TargetServer.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # TargetServer configuration. TargetServers are used to decouple a proxy's
      # TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
    "host": "A String", # Required. The host name this target connects to. Value must be a valid
        # hostname as described by RFC-1123.
    "name": "A String", # Required. The resource id of this target server. Values must match the
        # regular expression
    "description": "A String", # Optional. A human-readable description of this TargetServer.
    "port": 42, # Required. The port number this target connects to on the given host. Value
        # must be between 1 and 65535, inclusive.
    "isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers
        # are used in load balancing configurations, and one or more TargetServers
        # need to taken out of rotation periodically. Defaults to true.
    "sSLInfo": { # TLS configuration information for # Optional. Specifies TLS configuration info for this TargetServer. The JSON
        # name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge
        # originally supported SSL, and the name is still used for TLS configuration.
        # VirtualHosts and
        # TargetServers.
      "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names
          # listed in:
          # http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites
        "A String",
      ],
      "enabled": True or False, # Required. Enables one-way TLS.
      "trustStore": "A String", # The resource ID of the truststore.
          # References not yet supported.
      "keyAlias": "A String", # Required if `client_auth_enabled` is true. The resource ID for the
          # alias containing the private key and cert.
      "ignoreValidationErrors": True or False, # If true, Edge ignores TLS certificate errors. Valid when configuring TLS
          # for target servers and target endpoints, and when configuring virtual hosts
          # that use 2-way TLS.
          #
          # When used with a target endpoint/target server, if the backend system uses
          # SNI and returns a cert with a subject Distinguished Name (DN) that does not
          # match the hostname, there is no way to ignore the error and the connection
          # fails.
      "protocols": [ # The TLS versioins to be used.
        "A String",
      ],
      "commonName": { # The TLS Common Name of the certificate.
        "value": "A String", # The TLS Common Name string of the certificate.
        "wildcardMatch": True or False, # Indicates whether the cert should be matched against as a wildcard cert.
      },
      "clientAuthEnabled": True or False, # Optional. Enables two-way TLS.
      "keyStore": "A String", # Required if `client_auth_enabled` is true. The resource ID of the
          # keystore. References not yet supported.
    },
  }
delete(name, x__xgafv=None)
Deletes a TargetServer from an environment. Returns the deleted
TargetServer resource.

Args:
  name: string, Required. The name of the TargetServer to delete. Must be
of the form
`organizations/{org}/environments/{env}/targetservers/{target_server_id}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # TargetServer configuration. TargetServers are used to decouple a proxy's
      # TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
    "host": "A String", # Required. The host name this target connects to. Value must be a valid
        # hostname as described by RFC-1123.
    "name": "A String", # Required. The resource id of this target server. Values must match the
        # regular expression
    "description": "A String", # Optional. A human-readable description of this TargetServer.
    "port": 42, # Required. The port number this target connects to on the given host. Value
        # must be between 1 and 65535, inclusive.
    "isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers
        # are used in load balancing configurations, and one or more TargetServers
        # need to taken out of rotation periodically. Defaults to true.
    "sSLInfo": { # TLS configuration information for # Optional. Specifies TLS configuration info for this TargetServer. The JSON
        # name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge
        # originally supported SSL, and the name is still used for TLS configuration.
        # VirtualHosts and
        # TargetServers.
      "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names
          # listed in:
          # http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites
        "A String",
      ],
      "enabled": True or False, # Required. Enables one-way TLS.
      "trustStore": "A String", # The resource ID of the truststore.
          # References not yet supported.
      "keyAlias": "A String", # Required if `client_auth_enabled` is true. The resource ID for the
          # alias containing the private key and cert.
      "ignoreValidationErrors": True or False, # If true, Edge ignores TLS certificate errors. Valid when configuring TLS
          # for target servers and target endpoints, and when configuring virtual hosts
          # that use 2-way TLS.
          #
          # When used with a target endpoint/target server, if the backend system uses
          # SNI and returns a cert with a subject Distinguished Name (DN) that does not
          # match the hostname, there is no way to ignore the error and the connection
          # fails.
      "protocols": [ # The TLS versioins to be used.
        "A String",
      ],
      "commonName": { # The TLS Common Name of the certificate.
        "value": "A String", # The TLS Common Name string of the certificate.
        "wildcardMatch": True or False, # Indicates whether the cert should be matched against as a wildcard cert.
      },
      "clientAuthEnabled": True or False, # Optional. Enables two-way TLS.
      "keyStore": "A String", # Required if `client_auth_enabled` is true. The resource ID of the
          # keystore. References not yet supported.
    },
  }
get(name, x__xgafv=None)
Gets a TargetServer resource.

Args:
  name: string, Required. The name of the TargetServer to get. Must be of the form
`organizations/{org}/environments/{env}/targetservers/{target_server_id}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # TargetServer configuration. TargetServers are used to decouple a proxy's
      # TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
    "host": "A String", # Required. The host name this target connects to. Value must be a valid
        # hostname as described by RFC-1123.
    "name": "A String", # Required. The resource id of this target server. Values must match the
        # regular expression
    "description": "A String", # Optional. A human-readable description of this TargetServer.
    "port": 42, # Required. The port number this target connects to on the given host. Value
        # must be between 1 and 65535, inclusive.
    "isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers
        # are used in load balancing configurations, and one or more TargetServers
        # need to taken out of rotation periodically. Defaults to true.
    "sSLInfo": { # TLS configuration information for # Optional. Specifies TLS configuration info for this TargetServer. The JSON
        # name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge
        # originally supported SSL, and the name is still used for TLS configuration.
        # VirtualHosts and
        # TargetServers.
      "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names
          # listed in:
          # http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites
        "A String",
      ],
      "enabled": True or False, # Required. Enables one-way TLS.
      "trustStore": "A String", # The resource ID of the truststore.
          # References not yet supported.
      "keyAlias": "A String", # Required if `client_auth_enabled` is true. The resource ID for the
          # alias containing the private key and cert.
      "ignoreValidationErrors": True or False, # If true, Edge ignores TLS certificate errors. Valid when configuring TLS
          # for target servers and target endpoints, and when configuring virtual hosts
          # that use 2-way TLS.
          #
          # When used with a target endpoint/target server, if the backend system uses
          # SNI and returns a cert with a subject Distinguished Name (DN) that does not
          # match the hostname, there is no way to ignore the error and the connection
          # fails.
      "protocols": [ # The TLS versioins to be used.
        "A String",
      ],
      "commonName": { # The TLS Common Name of the certificate.
        "value": "A String", # The TLS Common Name string of the certificate.
        "wildcardMatch": True or False, # Indicates whether the cert should be matched against as a wildcard cert.
      },
      "clientAuthEnabled": True or False, # Optional. Enables two-way TLS.
      "keyStore": "A String", # Required if `client_auth_enabled` is true. The resource ID of the
          # keystore. References not yet supported.
    },
  }
update(name, body=None, x__xgafv=None)
Updates an existing TargetServer. Note that this operation has PUT
semantics; it will replace the entirety of the existing TargetServer with
the resource in the request body.

Args:
  name: string, Required. The name of the TargetServer to replace. Must be of the form
`organizations/{org}/environments/{env}/targetservers/{target_server_id}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # TargetServer configuration. TargetServers are used to decouple a proxy's
    # TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
  "host": "A String", # Required. The host name this target connects to. Value must be a valid
      # hostname as described by RFC-1123.
  "name": "A String", # Required. The resource id of this target server. Values must match the
      # regular expression
  "description": "A String", # Optional. A human-readable description of this TargetServer.
  "port": 42, # Required. The port number this target connects to on the given host. Value
      # must be between 1 and 65535, inclusive.
  "isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers
      # are used in load balancing configurations, and one or more TargetServers
      # need to taken out of rotation periodically. Defaults to true.
  "sSLInfo": { # TLS configuration information for # Optional. Specifies TLS configuration info for this TargetServer. The JSON
      # name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge
      # originally supported SSL, and the name is still used for TLS configuration.
      # VirtualHosts and
      # TargetServers.
    "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names
        # listed in:
        # http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites
      "A String",
    ],
    "enabled": True or False, # Required. Enables one-way TLS.
    "trustStore": "A String", # The resource ID of the truststore.
        # References not yet supported.
    "keyAlias": "A String", # Required if `client_auth_enabled` is true. The resource ID for the
        # alias containing the private key and cert.
    "ignoreValidationErrors": True or False, # If true, Edge ignores TLS certificate errors. Valid when configuring TLS
        # for target servers and target endpoints, and when configuring virtual hosts
        # that use 2-way TLS.
        #
        # When used with a target endpoint/target server, if the backend system uses
        # SNI and returns a cert with a subject Distinguished Name (DN) that does not
        # match the hostname, there is no way to ignore the error and the connection
        # fails.
    "protocols": [ # The TLS versioins to be used.
      "A String",
    ],
    "commonName": { # The TLS Common Name of the certificate.
      "value": "A String", # The TLS Common Name string of the certificate.
      "wildcardMatch": True or False, # Indicates whether the cert should be matched against as a wildcard cert.
    },
    "clientAuthEnabled": True or False, # Optional. Enables two-way TLS.
    "keyStore": "A String", # Required if `client_auth_enabled` is true. The resource ID of the
        # keystore. References not yet supported.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # TargetServer configuration. TargetServers are used to decouple a proxy's
      # TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
    "host": "A String", # Required. The host name this target connects to. Value must be a valid
        # hostname as described by RFC-1123.
    "name": "A String", # Required. The resource id of this target server. Values must match the
        # regular expression
    "description": "A String", # Optional. A human-readable description of this TargetServer.
    "port": 42, # Required. The port number this target connects to on the given host. Value
        # must be between 1 and 65535, inclusive.
    "isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers
        # are used in load balancing configurations, and one or more TargetServers
        # need to taken out of rotation periodically. Defaults to true.
    "sSLInfo": { # TLS configuration information for # Optional. Specifies TLS configuration info for this TargetServer. The JSON
        # name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge
        # originally supported SSL, and the name is still used for TLS configuration.
        # VirtualHosts and
        # TargetServers.
      "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names
          # listed in:
          # http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites
        "A String",
      ],
      "enabled": True or False, # Required. Enables one-way TLS.
      "trustStore": "A String", # The resource ID of the truststore.
          # References not yet supported.
      "keyAlias": "A String", # Required if `client_auth_enabled` is true. The resource ID for the
          # alias containing the private key and cert.
      "ignoreValidationErrors": True or False, # If true, Edge ignores TLS certificate errors. Valid when configuring TLS
          # for target servers and target endpoints, and when configuring virtual hosts
          # that use 2-way TLS.
          #
          # When used with a target endpoint/target server, if the backend system uses
          # SNI and returns a cert with a subject Distinguished Name (DN) that does not
          # match the hostname, there is no way to ignore the error and the connection
          # fails.
      "protocols": [ # The TLS versioins to be used.
        "A String",
      ],
      "commonName": { # The TLS Common Name of the certificate.
        "value": "A String", # The TLS Common Name string of the certificate.
        "wildcardMatch": True or False, # Indicates whether the cert should be matched against as a wildcard cert.
      },
      "clientAuthEnabled": True or False, # Optional. Enables two-way TLS.
      "keyStore": "A String", # Required if `client_auth_enabled` is true. The resource ID of the
          # keystore. References not yet supported.
    },
  }