Class: Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/gkeconnect/gateway/v1beta1/control.rb

Overview

A request for connection information for a particular membership.

Defined Under Namespace

Modules: OperatingSystem

Instance Attribute Summary collapse

Instance Attribute Details

#force_use_agent ⇒ ::Boolean

Returns Optional. Whether to force the use of Connect Agent-based transport.

This will return a configuration that uses Connect Agent as the underlying transport mechanism for cluster types that would otherwise have used a different transport. Requires that Connect Agent be installed on the cluster. Setting this field to false is equivalent to not setting it.

Returns:

  • (::Boolean) —

    Optional. Whether to force the use of Connect Agent-based transport.

    This will return a configuration that uses Connect Agent as the underlying transport mechanism for cluster types that would otherwise have used a different transport. Requires that Connect Agent be installed on the cluster. Setting this field to false is equivalent to not setting it.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'proto_docs/google/cloud/gkeconnect/gateway/v1beta1/control.rb', line 52

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

  # Operating systems requiring specialized kubeconfigs.
  module OperatingSystem
    # Generates a kubeconfig that works for all operating systems not defined
    # below.
    OPERATING_SYSTEM_UNSPECIFIED = 0

    # Generates a kubeconfig that is specifically designed to work with
    # Windows.
    OPERATING_SYSTEM_WINDOWS = 1
  end
end

#kubernetes_namespace ⇒ ::String

Returns Optional. The namespace to use in the kubeconfig context.

If this field is specified, the server will set the namespace field in kubeconfig context. If not specified, the namespace field is omitted.

Returns:

  • (::String) —

    Optional. The namespace to use in the kubeconfig context.

    If this field is specified, the server will set the namespace field in kubeconfig context. If not specified, the namespace field is omitted.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'proto_docs/google/cloud/gkeconnect/gateway/v1beta1/control.rb', line 52

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

  # Operating systems requiring specialized kubeconfigs.
  module OperatingSystem
    # Generates a kubeconfig that works for all operating systems not defined
    # below.
    OPERATING_SYSTEM_UNSPECIFIED = 0

    # Generates a kubeconfig that is specifically designed to work with
    # Windows.
    OPERATING_SYSTEM_WINDOWS = 1
  end
end

#name ⇒ ::String

Returns Required. The Fleet membership resource.

Returns:

  • (::String) —

    Required. The Fleet membership resource.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'proto_docs/google/cloud/gkeconnect/gateway/v1beta1/control.rb', line 52

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

  # Operating systems requiring specialized kubeconfigs.
  module OperatingSystem
    # Generates a kubeconfig that works for all operating systems not defined
    # below.
    OPERATING_SYSTEM_UNSPECIFIED = 0

    # Generates a kubeconfig that is specifically designed to work with
    # Windows.
    OPERATING_SYSTEM_WINDOWS = 1
  end
end

#operating_system ⇒ ::Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsRequest::OperatingSystem

Returns Optional. The operating system where the kubeconfig will be used.

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'proto_docs/google/cloud/gkeconnect/gateway/v1beta1/control.rb', line 52

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

  # Operating systems requiring specialized kubeconfigs.
  module OperatingSystem
    # Generates a kubeconfig that works for all operating systems not defined
    # below.
    OPERATING_SYSTEM_UNSPECIFIED = 0

    # Generates a kubeconfig that is specifically designed to work with
    # Windows.
    OPERATING_SYSTEM_WINDOWS = 1
  end
end

#version ⇒ ::String

Returns Optional. The Connect Gateway version to be used in the resulting configuration.

Leave this field blank to let the server choose the version (recommended).

Returns:

  • (::String) —

    Optional. The Connect Gateway version to be used in the resulting configuration.

    Leave this field blank to let the server choose the version (recommended).



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'proto_docs/google/cloud/gkeconnect/gateway/v1beta1/control.rb', line 52

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

  # Operating systems requiring specialized kubeconfigs.
  module OperatingSystem
    # Generates a kubeconfig that works for all operating systems not defined
    # below.
    OPERATING_SYSTEM_UNSPECIFIED = 0

    # Generates a kubeconfig that is specifically designed to work with
    # Windows.
    OPERATING_SYSTEM_WINDOWS = 1
  end
end