Class AzureClient

  • All Implemented Interfaces:
    AzureClientOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class AzureClient
    extends com.google.protobuf.GeneratedMessageV3
    implements AzureClientOrBuilder
     `AzureClient` resources hold client authentication information needed by the
     Anthos Multi-Cloud API to manage Azure resources on your Azure subscription.
    
     When an [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] is
     created, an `AzureClient` resource needs to be provided and all operations on
     Azure resources associated to that cluster will authenticate to Azure
     services using the given client.
    
     `AzureClient` resources are immutable and cannot be modified upon creation.
    
     Each `AzureClient` resource is bound to a single Azure Active Directory
     Application and tenant.
     
    Protobuf type google.cloud.gkemulticloud.v1.AzureClient
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getName

        public String getName()
         The name of this resource.
        
         `AzureClient` resource names are formatted as
         `projects/<project-number>/locations/<region>/azureClients/<client-id>`.
        
         See [Resource Names](https://cloud.google.com/apis/design/resource_names)
         for more details on Google Cloud resource names.
         
        string name = 1;
        Specified by:
        getName in interface AzureClientOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The name of this resource.
        
         `AzureClient` resource names are formatted as
         `projects/<project-number>/locations/<region>/azureClients/<client-id>`.
        
         See [Resource Names](https://cloud.google.com/apis/design/resource_names)
         for more details on Google Cloud resource names.
         
        string name = 1;
        Specified by:
        getNameBytes in interface AzureClientOrBuilder
        Returns:
        The bytes for name.
      • getTenantId

        public String getTenantId()
         Required. The Azure Active Directory Tenant ID.
         
        string tenant_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTenantId in interface AzureClientOrBuilder
        Returns:
        The tenantId.
      • getTenantIdBytes

        public com.google.protobuf.ByteString getTenantIdBytes()
         Required. The Azure Active Directory Tenant ID.
         
        string tenant_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTenantIdBytes in interface AzureClientOrBuilder
        Returns:
        The bytes for tenantId.
      • getApplicationId

        public String getApplicationId()
         Required. The Azure Active Directory Application ID.
         
        string application_id = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getApplicationId in interface AzureClientOrBuilder
        Returns:
        The applicationId.
      • getApplicationIdBytes

        public com.google.protobuf.ByteString getApplicationIdBytes()
         Required. The Azure Active Directory Application ID.
         
        string application_id = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getApplicationIdBytes in interface AzureClientOrBuilder
        Returns:
        The bytes for applicationId.
      • getReconciling

        public boolean getReconciling()
         Output only. If set, there are currently pending changes to the client.
         
        bool reconciling = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getReconciling in interface AzureClientOrBuilder
        Returns:
        The reconciling.
      • getAnnotationsCount

        public int getAnnotationsCount()
        Description copied from interface: AzureClientOrBuilder
         Optional. Annotations on the resource.
        
         This field has the same restrictions as Kubernetes annotations.
         The total size of all keys and values combined is limited to 256k.
         Keys can have 2 segments: prefix (optional) and name (required),
         separated by a slash (/).
         Prefix must be a DNS subdomain.
         Name must be 63 characters or less, begin and end with alphanumerics,
         with dashes (-), underscores (_), dots (.), and alphanumerics between.
         
        map<string, string> annotations = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAnnotationsCount in interface AzureClientOrBuilder
      • containsAnnotations

        public boolean containsAnnotations​(String key)
         Optional. Annotations on the resource.
        
         This field has the same restrictions as Kubernetes annotations.
         The total size of all keys and values combined is limited to 256k.
         Keys can have 2 segments: prefix (optional) and name (required),
         separated by a slash (/).
         Prefix must be a DNS subdomain.
         Name must be 63 characters or less, begin and end with alphanumerics,
         with dashes (-), underscores (_), dots (.), and alphanumerics between.
         
        map<string, string> annotations = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsAnnotations in interface AzureClientOrBuilder
      • getAnnotationsMap

        public Map<String,​String> getAnnotationsMap()
         Optional. Annotations on the resource.
        
         This field has the same restrictions as Kubernetes annotations.
         The total size of all keys and values combined is limited to 256k.
         Keys can have 2 segments: prefix (optional) and name (required),
         separated by a slash (/).
         Prefix must be a DNS subdomain.
         Name must be 63 characters or less, begin and end with alphanumerics,
         with dashes (-), underscores (_), dots (.), and alphanumerics between.
         
        map<string, string> annotations = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAnnotationsMap in interface AzureClientOrBuilder
      • getAnnotationsOrDefault

        public String getAnnotationsOrDefault​(String key,
                                              String defaultValue)
         Optional. Annotations on the resource.
        
         This field has the same restrictions as Kubernetes annotations.
         The total size of all keys and values combined is limited to 256k.
         Keys can have 2 segments: prefix (optional) and name (required),
         separated by a slash (/).
         Prefix must be a DNS subdomain.
         Name must be 63 characters or less, begin and end with alphanumerics,
         with dashes (-), underscores (_), dots (.), and alphanumerics between.
         
        map<string, string> annotations = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAnnotationsOrDefault in interface AzureClientOrBuilder
      • getAnnotationsOrThrow

        public String getAnnotationsOrThrow​(String key)
         Optional. Annotations on the resource.
        
         This field has the same restrictions as Kubernetes annotations.
         The total size of all keys and values combined is limited to 256k.
         Keys can have 2 segments: prefix (optional) and name (required),
         separated by a slash (/).
         Prefix must be a DNS subdomain.
         Name must be 63 characters or less, begin and end with alphanumerics,
         with dashes (-), underscores (_), dots (.), and alphanumerics between.
         
        map<string, string> annotations = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAnnotationsOrThrow in interface AzureClientOrBuilder
      • getPemCertificate

        public String getPemCertificate()
         Output only. The PEM encoded x509 certificate.
         
        string pem_certificate = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPemCertificate in interface AzureClientOrBuilder
        Returns:
        The pemCertificate.
      • getPemCertificateBytes

        public com.google.protobuf.ByteString getPemCertificateBytes()
         Output only. The PEM encoded x509 certificate.
         
        string pem_certificate = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPemCertificateBytes in interface AzureClientOrBuilder
        Returns:
        The bytes for pemCertificate.
      • getUid

        public String getUid()
         Output only. A globally unique identifier for the client.
         
        string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUid in interface AzureClientOrBuilder
        Returns:
        The uid.
      • getUidBytes

        public com.google.protobuf.ByteString getUidBytes()
         Output only. A globally unique identifier for the client.
         
        string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUidBytes in interface AzureClientOrBuilder
        Returns:
        The bytes for uid.
      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time at which this resource was created.
         
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface AzureClientOrBuilder
        Returns:
        Whether the createTime field is set.
      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time at which this resource was created.
         
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface AzureClientOrBuilder
        Returns:
        The createTime.
      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time at which this resource was created.
         
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface AzureClientOrBuilder
      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. The time at which this client was last updated.
         
        .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface AzureClientOrBuilder
        Returns:
        Whether the updateTime field is set.
      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The time at which this client was last updated.
         
        .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface AzureClientOrBuilder
        Returns:
        The updateTime.
      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The time at which this client was last updated.
         
        .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface AzureClientOrBuilder
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static AzureClient parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AzureClient parseFrom​(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AzureClient parseFrom​(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AzureClient parseFrom​(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AzureClient parseFrom​(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AzureClient parseFrom​(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AzureClient parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Throws:
        IOException
      • newBuilderForType

        public AzureClient.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public AzureClient.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected AzureClient.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static AzureClient getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<AzureClient> parser()
      • getParserForType

        public com.google.protobuf.Parser<AzureClient> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public AzureClient getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder